4225 lines
247 KiB
XML
4225 lines
247 KiB
XML
<?xml version="1.0"?>
|
||
<doc>
|
||
<assembly>
|
||
<name>InTheHand</name>
|
||
</assembly>
|
||
<members>
|
||
<member name="T:InTheHand.ApplicationModel.Calls.PhoneCallManager">
|
||
<summary>
|
||
Provides methods for launching the built-in phone call UI.
|
||
</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>macOS</term><description>OS X 10.7 and later</description></item>
|
||
<item><term>iOS</term><description>iOS 9.0 and later</description></item>
|
||
<item><term>Tizen</term><description>Tizen 4.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.ApplicationModel.Calls.PhoneCallManager.ShowPhoneCallUI(System.String,System.String)">
|
||
<summary>
|
||
Launches the built-in phone call UI with the specified phone number and display name.
|
||
</summary>
|
||
<param name="phoneNumber">A phone number.
|
||
This should be in international format e.g. +12345678901</param>
|
||
<param name="displayName">A display name.</param>
|
||
</member>
|
||
<member name="T:InTheHand.ApplicationModel.Chat.ChatMessage">
|
||
<summary>
|
||
Represents a chat message.
|
||
</summary>
|
||
</member>
|
||
<member name="M:InTheHand.ApplicationModel.Chat.ChatMessage.#ctor">
|
||
<summary>
|
||
Creates a new instance of the <see cref="T:InTheHand.ApplicationModel.Chat.ChatMessage"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.ApplicationModel.Chat.ChatMessage.Body">
|
||
<summary>
|
||
Gets or sets the body of the chat message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.ApplicationModel.Chat.ChatMessage.Recipients">
|
||
<summary>
|
||
Gets the list of recipients of the message.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.ApplicationModel.Chat.ChatMessageManager">
|
||
<summary>
|
||
Provides methods for managing chat messages.
|
||
</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>macOS</term><description>OS X 10.7 and later</description></item>
|
||
<item><term>iOS</term><description>iOS 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.ApplicationModel.Chat.ChatMessageManager.ShowComposeSmsMessageAsync(InTheHand.ApplicationModel.Chat.ChatMessage)">
|
||
<summary>
|
||
Shows the compose SMS dialog, pre-populated with data from the supplied ChatMessage object, allowing the user to send an SMS message.
|
||
</summary>
|
||
<param name="message">The chat message.</param>
|
||
<returns>An asynchronous action.</returns>
|
||
</member>
|
||
<member name="M:InTheHand.ApplicationModel.Chat.ChatMessageManager.ShowSmsSettings">
|
||
<summary>
|
||
Launches the device's SMS settings app.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.ApplicationModel.DataTransfer.Clipboard">
|
||
<summary>
|
||
Gets and sets information from the clipboard object.
|
||
</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>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.ApplicationModel.DataTransfer.Clipboard.Clear">
|
||
<summary>
|
||
Removes all data from the Clipboard.
|
||
</summary>
|
||
</member>
|
||
<member name="M:InTheHand.ApplicationModel.DataTransfer.Clipboard.GetContent">
|
||
<summary>
|
||
Gets the current content that is stored in the clipboard object.
|
||
</summary>
|
||
<returns>Contains the content of the Clipboard.</returns>
|
||
</member>
|
||
<member name="M:InTheHand.ApplicationModel.DataTransfer.Clipboard.SetContent(InTheHand.ApplicationModel.DataTransfer.DataPackage)">
|
||
<summary>
|
||
Sets the current content that is stored in the clipboard object.
|
||
</summary>
|
||
<param name="content">Contains the content of the clipboard.
|
||
If NULL, the clipboard is emptied.</param>
|
||
</member>
|
||
<member name="E:InTheHand.ApplicationModel.DataTransfer.Clipboard.ContentChanged">
|
||
<summary>
|
||
Occurs when the data stored in the Clipboard changes.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.ApplicationModel.DataTransfer.DataPackage">
|
||
<summary>
|
||
Contains the data that a user wants to exchange with another app.
|
||
</summary>
|
||
</member>
|
||
<member name="M:InTheHand.ApplicationModel.DataTransfer.DataPackage.#ctor">
|
||
<summary>
|
||
Constructor that creates a new <see cref="T:InTheHand.ApplicationModel.DataTransfer.DataPackage"/>.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.ApplicationModel.DataTransfer.DataPackage.Properties">
|
||
<summary>
|
||
Allows you to get and set properties like the title of the content being shared.
|
||
</summary>
|
||
</member>
|
||
<member name="M:InTheHand.ApplicationModel.DataTransfer.DataPackage.GetView">
|
||
<summary>
|
||
Returns a <see cref="T:InTheHand.ApplicationModel.DataTransfer.DataPackageView"/> object.
|
||
This object is a read-only copy of the <see cref="T:InTheHand.ApplicationModel.DataTransfer.DataPackage"/> object.
|
||
</summary>
|
||
<returns>The object that is a read-only copy of the <see cref="T:InTheHand.ApplicationModel.DataTransfer.DataPackage"/> object.</returns>
|
||
</member>
|
||
<member name="M:InTheHand.ApplicationModel.DataTransfer.DataPackage.SetData(System.String,System.Object)">
|
||
<summary>
|
||
Sets the data contained in the DataPackage.
|
||
</summary>
|
||
<param name="formatId">Specifies the format of the data.
|
||
We recommend that you set this value by using the StandardDataFormats class.</param>
|
||
<param name="value">Specifies the content that the DataPackage contains.</param>
|
||
</member>
|
||
<member name="M:InTheHand.ApplicationModel.DataTransfer.DataPackage.SetDataProvider(System.String,InTheHand.ApplicationModel.DataTransfer.DataProviderHandler)">
|
||
<summary>
|
||
Sets a delegate to handle requests from the target app.
|
||
</summary>
|
||
<param name="formatId">Specifies the format of the data.
|
||
We recommend that you set this value by using the StandardDataFormats class.</param>
|
||
<param name="delayRenderer">A delegate that is responsible for processing requests from a target app.</param>
|
||
</member>
|
||
<member name="M:InTheHand.ApplicationModel.DataTransfer.DataPackage.SetText(System.String)">
|
||
<summary>
|
||
Sets the text that a <see cref="T:InTheHand.ApplicationModel.DataTransfer.DataPackage"/> contains.
|
||
</summary>
|
||
<param name="value">The text.</param>
|
||
</member>
|
||
<member name="M:InTheHand.ApplicationModel.DataTransfer.DataPackage.SetWebLink(System.Uri)">
|
||
<summary>
|
||
Sets the web link that a <see cref="T:InTheHand.ApplicationModel.DataTransfer.DataPackage"/> contains.
|
||
</summary>
|
||
<param name="value">A URI with an http or https scheme that corresponds to the content being displayed to the user.</param>
|
||
<remarks>Whenever possible, you should set this property.
|
||
A source app provides a value for this property, and a target app reads the value.
|
||
Use this property to indicate the source of the shared content.</remarks>
|
||
</member>
|
||
<member name="M:InTheHand.ApplicationModel.DataTransfer.DataPackage.SetApplicationLink(System.Uri)">
|
||
<summary>
|
||
Sets the application link that a <see cref="T:InTheHand.ApplicationModel.DataTransfer.DataPackage"/> contains.
|
||
</summary>
|
||
<param name="value">A URI with a scheme that isn't http or https that's handled by the source app. </param>
|
||
<remarks>Whenever possible, you should set this property.
|
||
This URI represents a deep link that takes the user back to the currently displayed content.
|
||
A source app provides a value for this property, and a target app reads the value.
|
||
Use this property to indicate the source of the shared content.
|
||
<para>The scheme of this URI must not be http or https.
|
||
The app sharing this URI must be capable of being the default handler, although it may not be set as the default handler.</para></remarks>
|
||
</member>
|
||
<member name="T:InTheHand.ApplicationModel.DataTransfer.DataPackagePropertySet">
|
||
<summary>
|
||
Defines a set of properties to use with a <see cref="T:InTheHand.ApplicationModel.DataTransfer.DataPackage"/> object.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.ApplicationModel.DataTransfer.DataPackagePropertySet.Title">
|
||
<summary>
|
||
Gets or sets the text that displays as a title for the contents of the <see cref="T:InTheHand.ApplicationModel.DataTransfer.DataPackage"/> object.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.ApplicationModel.DataTransfer.DataPackagePropertySet.Description">
|
||
<summary>
|
||
Gets or sets text that describes the contents of the <see cref="T:InTheHand.ApplicationModel.DataTransfer.DataPackage"/>.
|
||
</summary>
|
||
<remarks>We recommend adding a description to a DataPackage object if you can.
|
||
Target apps can use this description to help users identify what content they're sharing.</remarks>
|
||
</member>
|
||
<member name="T:InTheHand.ApplicationModel.DataTransfer.DataPackagePropertySetView">
|
||
<summary>
|
||
Gets the set of properties of a <see cref="T:InTheHand.ApplicationModel.DataTransfer.DataPackageView"/> object.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.ApplicationModel.DataTransfer.DataPackagePropertySetView.Title">
|
||
<summary>
|
||
Gets the text that displays as a title for the contents of the <see cref="T:InTheHand.ApplicationModel.DataTransfer.DataPackageView"/> object.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.ApplicationModel.DataTransfer.DataPackagePropertySetView.Description">
|
||
<summary>
|
||
Gets the text that describes the contents of the <see cref="T:InTheHand.ApplicationModel.DataTransfer.DataPackage"/>.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.ApplicationModel.DataTransfer.DataPackageView">
|
||
<summary>
|
||
A read-only version of a <see cref="T:InTheHand.ApplicationModel.DataTransfer.DataPackage"/>.
|
||
Apps that receive shared content get this object when acquiring content.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.ApplicationModel.DataTransfer.DataPackageView.AvailableFormats">
|
||
<summary>
|
||
Returns the formats the <see cref="T:InTheHand.ApplicationModel.DataTransfer.DataPackageView"/> contains.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.ApplicationModel.DataTransfer.DataPackageView.Properties">
|
||
<summary>
|
||
Gets a <see cref="T:InTheHand.ApplicationModel.DataTransfer.DataPackagePropertySetView"/> object, which contains a read-only set of properties for the data in the <see cref="T:InTheHand.ApplicationModel.DataTransfer.DataPackageView"/> object.
|
||
</summary>
|
||
</member>
|
||
<member name="M:InTheHand.ApplicationModel.DataTransfer.DataPackageView.Contains(System.String)">
|
||
<summary>
|
||
Checks to see if the <see cref="T:InTheHand.ApplicationModel.DataTransfer.DataPackageView"/> contains a specific data format.
|
||
</summary>
|
||
<param name="formatId">The name of the format.</param>
|
||
<returns>True if the <see cref="T:InTheHand.ApplicationModel.DataTransfer.DataPackageView"/> contains the format; false otherwise.</returns>
|
||
</member>
|
||
<member name="M:InTheHand.ApplicationModel.DataTransfer.DataPackageView.GetDataAsync(System.String)">
|
||
<summary>
|
||
Gets the data contained in the <see cref="T:InTheHand.ApplicationModel.DataTransfer.DataPackageView"/>.
|
||
</summary>
|
||
<param name="formatId">The format of the data.</param>
|
||
<returns>The data.</returns>
|
||
</member>
|
||
<member name="M:InTheHand.ApplicationModel.DataTransfer.DataPackageView.GetTextAsync">
|
||
<summary>
|
||
Gets the text in the <see cref="T:InTheHand.ApplicationModel.DataTransfer.DataPackageView"/> object.
|
||
</summary>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:InTheHand.ApplicationModel.DataTransfer.DataPackageView.GetApplicationLinkAsync">
|
||
<summary>
|
||
Gets the application link in the <see cref="T:InTheHand.ApplicationModel.DataTransfer.DataPackageView"/> object.
|
||
</summary>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:InTheHand.ApplicationModel.DataTransfer.DataPackageView.GetWebLinkAsync">
|
||
<summary>
|
||
Gets the web link in the <see cref="T:InTheHand.ApplicationModel.DataTransfer.DataPackageView"/> object.
|
||
</summary>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="T:InTheHand.ApplicationModel.DataTransfer.DataProviderRequest">
|
||
<summary>
|
||
An object of this type is passed to the <see cref="T:InTheHand.ApplicationModel.DataTransfer.DataProviderHandler"/> delegate.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.ApplicationModel.DataTransfer.DataProviderRequest.FormatId">
|
||
<summary>
|
||
Specifies the format id.
|
||
</summary>
|
||
</member>
|
||
<member name="M:InTheHand.ApplicationModel.DataTransfer.DataProviderRequest.SetData(System.Object)">
|
||
<summary>
|
||
Sets the content of the DataPackage to be shared with a target app.
|
||
</summary>
|
||
<param name="value">The object associated with a particular format in the DataPackage.</param>
|
||
</member>
|
||
<member name="T:InTheHand.ApplicationModel.DataTransfer.DataProviderHandler">
|
||
<summary>
|
||
Provides data when the target app requests it, instead of including the data in the DataPackage ahead of time.
|
||
DataProviderHandler is used when the source app wants to avoid unnecessary work that is resource intensive, such as performing format conversions.
|
||
</summary>
|
||
<param name="request">Contains the data that the user wants to share.</param>
|
||
</member>
|
||
<member name="T:InTheHand.ApplicationModel.DataTransfer.DataRequestedEventArgs">
|
||
<summary>
|
||
Contains information about the DataRequested event.
|
||
The system fires this event when the user invokes the Share UI.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.ApplicationModel.DataTransfer.DataRequestedEventArgs.Request">
|
||
<summary>
|
||
Enables you to get the DataRequest object and either give it data or a failure message.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.ApplicationModel.DataTransfer.DataRequest">
|
||
<summary>
|
||
Lets your app supply the content the user wants to share or specify a message, if an error occurs.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.ApplicationModel.DataTransfer.DataRequest.Data">
|
||
<summary>
|
||
Sets or gets a DataPackage object that contains the content a user wants to share.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.ApplicationModel.DataTransfer.DataTransferManager">
|
||
<summary>
|
||
Programmatically initiates an exchange of content with other apps.
|
||
</summary>
|
||
<remarks>The <see cref="T:InTheHand.ApplicationModel.DataTransfer.DataTransferManager"/> class is a static class that you use to initiate sharing operations.
|
||
To use the class, first call the <see cref="M:InTheHand.ApplicationModel.DataTransfer.DataTransferManager.GetForCurrentView"/> method.
|
||
This method returns the <see cref="T:InTheHand.ApplicationModel.DataTransfer.DataTransferManager"/> object that is specific to the active window.
|
||
Next, you need to add an event listener for the datarequested event to the object.
|
||
This event is fired when your app starts a share operation programmatically.
|
||
<para>The DataTransferManager class includes a <see cref="M:InTheHand.ApplicationModel.DataTransfer.DataTransferManager.ShowShareUI"/> method, which you can use to programmatically start a share operation.
|
||
In general, we recommend against using this method.
|
||
Users expect to initiate share operations by using the Share charm—when you launch the operation programmatically, you can create an inconsistent user experience.
|
||
We include the method because there are a few scenarios in which the user might not recognize opportunities to share.
|
||
A good example is when the user achieves a high score in a game.</para>
|
||
<para>The <see cref="T:InTheHand.ApplicationModel.DataTransfer.DataTransferManager"/> class also has a <see cref="E:InTheHand.ApplicationModel.DataTransfer.DataTransferManager.TargetApplicationChosen"/> event.
|
||
Use this event when you want to capture what applications a user selects when sharing content from your app.</para></remarks>
|
||
</member>
|
||
<member name="M:InTheHand.ApplicationModel.DataTransfer.DataTransferManager.GetForCurrentView">
|
||
<summary>
|
||
Returns the <see cref="T:InTheHand.ApplicationModel.DataTransfer.DataTransferManager"/> object associated with the current window.
|
||
</summary>
|
||
<returns>The <see cref="T:InTheHand.ApplicationModel.DataTransfer.DataTransferManager"/> object associated with the current window.</returns>
|
||
</member>
|
||
<member name="M:InTheHand.ApplicationModel.DataTransfer.DataTransferManager.ShowShareUI">
|
||
<summary>
|
||
Programmatically initiates the user interface for sharing content with another app.
|
||
</summary>
|
||
</member>
|
||
<member name="E:InTheHand.ApplicationModel.DataTransfer.DataTransferManager.DataRequested">
|
||
<summary>
|
||
Occurs when a share operation starts.
|
||
</summary>
|
||
<remarks>This event is fired when a sharing operation starts.
|
||
To handle this event, you need to add an event listener to the <see cref="T:InTheHand.ApplicationModel.DataTransfer.DataTransferManager"/> object for the active window.
|
||
You can get this object through the <see cref="M:InTheHand.ApplicationModel.DataTransfer.DataTransferManager.GetForCurrentView"/> method.
|
||
<para>When handling a datarequested event, the most important property you need to be aware of is its request property.
|
||
This property contains a <see cref="T:InTheHand.ApplicationModel.DataTransfer.DataRequest"/> object.
|
||
Your app uses this object to provide the data that the user wants to share with a selected target app.</para></remarks>
|
||
</member>
|
||
<member name="E:InTheHand.ApplicationModel.DataTransfer.DataTransferManager.TargetApplicationChosen">
|
||
<summary>
|
||
Occurs when the user chooses a target app in a Share operation.
|
||
</summary>
|
||
<remarks>When the user chooses a target app to share content with, the system fires a TargetApplicationChosen event.
|
||
The app receiving the event can use this event to record information about the target app for business intelligence.
|
||
A common use of this event is to record which applications are used to complete different sharing actions, which in turn can help the source app create better experiences for the user.</remarks>
|
||
</member>
|
||
<member name="T:InTheHand.ApplicationModel.DataTransfer.StandardDataFormats">
|
||
<summary>
|
||
Contains static properties that return string values.
|
||
Each string corresponds to a known format ID.
|
||
Use this class to avoid errors in using string constants to specify data formats.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.ApplicationModel.DataTransfer.StandardDataFormats.Text">
|
||
<summary>
|
||
A read-only property that returns the format ID string value corresponding to the Text format.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.ApplicationModel.DataTransfer.StandardDataFormats.WebLink">
|
||
<summary>
|
||
A read-only property that returns the format ID string value corresponding to the Uniform Resource Identifier (URI) format.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.ApplicationModel.DataTransfer.StandardDataFormats.ApplicationLink">
|
||
<summary>
|
||
A read-only property that returns the format ID string value corresponding to the Uniform Resource Identifier (URI) format.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.ApplicationModel.DataTransfer.TargetApplicationChosenEventArgs">
|
||
<summary>
|
||
Contains information about the target app the user chose to share content with.
|
||
To get this object, you must handle the TargetApplicationChosen event.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.ApplicationModel.DataTransfer.TargetApplicationChosenEventArgs.ApplicationName">
|
||
<summary>
|
||
Contains the name of the app that the user chose to share content with.
|
||
</summary>
|
||
</member>
|
||
<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.Email.EmailManager">
|
||
<summary>
|
||
Allows an application to launch the email application with a new message displayed.
|
||
Use this to allow users to send email from your application.
|
||
</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>macOS</term><description>OS X 10.7 and later</description></item>
|
||
<item><term>iOS</term><description>iOS 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.ApplicationModel.Email.EmailManager.ShowComposeNewEmailAsync(InTheHand.ApplicationModel.Email.EmailMessage)">
|
||
<summary>
|
||
Launches the email application with a new message displayed.
|
||
</summary>
|
||
<param name="message">The email message that is displayed when the email application is launched.</param>
|
||
<returns>An asynchronous action used to indicate when the operation has completed.</returns>
|
||
</member>
|
||
<member name="T:InTheHand.ApplicationModel.Email.EmailMessage">
|
||
<summary>
|
||
Represents an email message.
|
||
</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>macOS</term><description>OS X 10.7 and later</description></item>
|
||
<item><term>iOS</term><description>iOS 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.ApplicationModel.Email.EmailMessage.#ctor">
|
||
<summary>
|
||
Creates an instance of the <see cref="T:InTheHand.ApplicationModel.Email.EmailMessage"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.ApplicationModel.Email.EmailMessage.Subject">
|
||
<summary>
|
||
Gets or sets the subject of the email message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.ApplicationModel.Email.EmailMessage.Body">
|
||
<summary>
|
||
Gets or sets the body of the email message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.ApplicationModel.Email.EmailMessage.To">
|
||
<summary>
|
||
Gets the direct recipients of the email message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.ApplicationModel.Email.EmailMessage.CC">
|
||
<summary>
|
||
Gets the recipients CC'd to the email message.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.ApplicationModel.Email.EmailMessage.Bcc">
|
||
<summary>
|
||
Gets the recipients BCC'd to the email message.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.ApplicationModel.Email.EmailRecipient">
|
||
<summary>
|
||
Represents an email recipient.
|
||
</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>macOS</term><description>OS X 10.7 and later</description></item>
|
||
<item><term>iOS</term><description>iOS 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.ApplicationModel.Email.EmailRecipient.#ctor">
|
||
<summary>
|
||
Initializes an instance of the EmailRecipient class.
|
||
</summary>
|
||
</member>
|
||
<member name="M:InTheHand.ApplicationModel.Email.EmailRecipient.#ctor(System.String)">
|
||
<summary>
|
||
Initializes an instance of the EmailRecipient class.
|
||
</summary>
|
||
<param name="address">The address of the recipient.</param>
|
||
</member>
|
||
<member name="M:InTheHand.ApplicationModel.Email.EmailRecipient.#ctor(System.String,System.String)">
|
||
<summary>
|
||
Initializes an instance of the EmailRecipient class.
|
||
</summary>
|
||
<param name="address">The address of the recipient.</param>
|
||
<param name="name">The name of the recipient.</param>
|
||
</member>
|
||
<member name="P:InTheHand.ApplicationModel.Email.EmailRecipient.Address">
|
||
<summary>
|
||
Gets or sets the address of the email recipient.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.ApplicationModel.Email.EmailRecipient.Name">
|
||
<summary>
|
||
Gets or sets the name of the email recipient.
|
||
</summary>
|
||
</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.ApplicationModel.Resources.ResourceLoader">
|
||
<summary>
|
||
Provides simplified access to app resources such as app UI strings.
|
||
</summary>
|
||
<remarks>
|
||
<list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<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.ApplicationModel.Resources.ResourceLoader.GetForCurrentView">
|
||
<summary>
|
||
Gets a ResourceLoader object for the Resources subtree of the currently running app's main ResourceMap.
|
||
This ResourceLoader uses a default context associated with the current view.
|
||
</summary>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:InTheHand.ApplicationModel.Resources.ResourceLoader.GetForViewIndependentUse">
|
||
<summary>
|
||
Gets a ResourceLoader object for the Resources subtree of the currently running app's main ResourceMap.
|
||
This ResourceLoader uses a default context that's not associated with any view.
|
||
</summary>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:InTheHand.ApplicationModel.Resources.ResourceLoader.GetString(System.String)">
|
||
<summary>
|
||
Returns the most appropriate string value of a resource, specified by resource identifier, for the default ResourceContext of the view in which the ResourceLoader was obtained using ResourceLoader.GetForCurrentView.
|
||
</summary>
|
||
<param name="resource">The resource identifier of the resource to be resolved.</param>
|
||
<returns>The most appropriate string value of the specified resource for the default ResourceContext.</returns>
|
||
</member>
|
||
<member name="T:InTheHand.ApplicationModel.Store.CurrentApp">
|
||
<summary>
|
||
Defines methods and properties you can use to get license and listing info about the current app and perform in-app purchases.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.ApplicationModel.Store.CurrentApp.AppId">
|
||
<summary>
|
||
Gets the GUID generated by the Windows Store when your app has been certified for listing in the Windows Store.
|
||
</summary>
|
||
</member>
|
||
<member name="M:InTheHand.ApplicationModel.Store.CurrentApp.RequestDetailsAsync">
|
||
<summary>
|
||
Creates the async operation that enables the user to view the app details.
|
||
</summary>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:InTheHand.ApplicationModel.Store.CurrentApp.RequestReviewAsync">
|
||
<summary>
|
||
Creates the async operation that enables the user to review the current app.
|
||
</summary>
|
||
<returns></returns>
|
||
</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.Devices.Input.KeyboardCapabilities">
|
||
<summary>
|
||
Supports the ability to determine the capabilities of any connected hardware keyboards.
|
||
</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>macOS</term><description>OS X 10.7 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 8 or later</description></item></list></remarks>
|
||
</member>
|
||
<member name="M:InTheHand.Devices.Input.KeyboardCapabilities.#ctor">
|
||
<summary>
|
||
Initializes a new instance of the <see cref="T:InTheHand.Devices.Input.KeyboardCapabilities"/> class.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.Devices.Input.KeyboardCapabilities.KeyboardPresent">
|
||
<summary>
|
||
Gets a value that indicates whether a device identifying itself as a keyboard is detected.
|
||
</summary>
|
||
<value>Returns 1 if a device identifying itself as a keyboard is detected. Otherwise, returns 0.</value>
|
||
</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.Media.Capture.CameraCaptureUI">
|
||
<summary>
|
||
Provides a full window UI for capturing audio, video, and photos from a camera.
|
||
</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>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 10 Mobile 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.Media.Capture.CameraCaptureUI.#ctor">
|
||
<summary>
|
||
Create a new CameraCaptureUI object.
|
||
</summary>
|
||
</member>
|
||
<member name="M:InTheHand.Media.Capture.CameraCaptureUI.CaptureFileAsync(InTheHand.Media.Capture.CameraCaptureUIMode)">
|
||
<summary>
|
||
Launches the CameraCaptureUI user interface.
|
||
</summary>
|
||
<param name="mode">Specifies whether the user interface that will be shown allows the user to capture a photo, capture a video, or capture both photos and videos.</param>
|
||
<returns>When this operation completes, a StorageFile object is returned.</returns>
|
||
</member>
|
||
<member name="T:InTheHand.Media.Capture.CameraCaptureUIMode">
|
||
<summary>
|
||
Determines whether the user interface for capturing from the attached camera allows capture of photos, videos, or both photos and videos.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Media.Capture.CameraCaptureUIMode.PhotoOrVideo">
|
||
<summary>
|
||
Either a photo or video can be captured.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Media.Capture.CameraCaptureUIMode.Photo">
|
||
<summary>
|
||
The user can only capture a photo.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.Media.Capture.CameraCaptureUIMode.Video">
|
||
<summary>
|
||
The user can only capture a video.
|
||
</summary>
|
||
</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.Networking.Sockets.NetworkStream">
|
||
<summary>
|
||
Provides the underlying stream of data for network access.
|
||
</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></list>
|
||
</remarks>
|
||
<seealso cref="!:System.Net.Sockets.NetworkStream"/>
|
||
</member>
|
||
<member name="M:InTheHand.Networking.Sockets.NetworkStream.#ctor(Android.Bluetooth.BluetoothSocket)">
|
||
<summary>
|
||
Creates a new instance of the NetworkStream for the specified <see cref="T:Android.Bluetooth.BluetoothSocket"/>
|
||
</summary>
|
||
<param name="socket"></param>
|
||
</member>
|
||
<member name="P:InTheHand.Networking.Sockets.NetworkStream.CanRead">
|
||
<summary>
|
||
Gets a value that indicates whether the NetworkStream supports reading.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.Networking.Sockets.NetworkStream.CanSeek">
|
||
<summary>
|
||
Gets a value that indicates whether the stream supports seeking. This property is not currently supported.This property always returns false.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.Networking.Sockets.NetworkStream.CanWrite">
|
||
<summary>
|
||
Gets a value that indicates whether the NetworkStream supports writing.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.Networking.Sockets.NetworkStream.Length">
|
||
<summary>
|
||
Gets the length of the data available on the stream.
|
||
This property is not currently supported and always throws a NotSupportedException.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.Networking.Sockets.NetworkStream.Position">
|
||
<summary>
|
||
Gets or sets the current position in the stream.
|
||
This property is not currently supported and always throws a NotSupportedException.
|
||
</summary>
|
||
</member>
|
||
<member name="M:InTheHand.Networking.Sockets.NetworkStream.Flush">
|
||
<summary>
|
||
Flushes data from the stream.
|
||
</summary>
|
||
</member>
|
||
<member name="M:InTheHand.Networking.Sockets.NetworkStream.Read(System.Byte[],System.Int32,System.Int32)">
|
||
<summary>
|
||
Reads data from the NetworkStream.
|
||
</summary>
|
||
<param name="buffer"></param>
|
||
<param name="offset"></param>
|
||
<param name="count"></param>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:InTheHand.Networking.Sockets.NetworkStream.Seek(System.Int64,System.IO.SeekOrigin)">
|
||
<summary>
|
||
Sets the current position of the stream to the given value.
|
||
This method is not currently supported and always throws a NotSupportedException.
|
||
</summary>
|
||
<param name="offset"></param>
|
||
<param name="origin"></param>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:InTheHand.Networking.Sockets.NetworkStream.SetLength(System.Int64)">
|
||
<summary>
|
||
Sets the length of the stream.
|
||
This method always throws a NotSupportedException.
|
||
</summary>
|
||
<param name="value"></param>
|
||
</member>
|
||
<member name="M:InTheHand.Networking.Sockets.NetworkStream.Write(System.Byte[],System.Int32,System.Int32)">
|
||
<summary>
|
||
Writes data to the NetworkStream.
|
||
</summary>
|
||
<param name="buffer"></param>
|
||
<param name="offset"></param>
|
||
<param name="count"></param>
|
||
</member>
|
||
<member name="M:InTheHand.Networking.Sockets.NetworkStream.Dispose(System.Boolean)">
|
||
<summary>
|
||
Releases the unmanaged resources used by the NetworkStream and optionally releases the managed resources.
|
||
</summary>
|
||
<param name="disposing"></param>
|
||
</member>
|
||
<member name="T:InTheHand.Phone.Devices.Notification.VibrationDevice">
|
||
<summary>
|
||
Vibrates the phone.
|
||
</summary>
|
||
<remarks>Phone devices include a vibration controller.
|
||
Your app can vibrate the phone for up to 5 seconds to notify the user of an important event.
|
||
Use the vibration feature in moderation.
|
||
Do not rely on the vibration feature for critical notifications, because the user can disable vibration
|
||
<para>To test an app that uses the vibration controller effectively, you have to test it on a physical device.
|
||
The emulator cannot simulate vibration and does not provide any audible or visual feedback that vibration is occurring.
|
||
<para>An app that is running in the background cannot vibrate the phone.</para>
|
||
If your code tries to use vibration while the app is running in the background, nothing happens, but no exception is raised.
|
||
If you want to vibrate the phone while your app is running in the background, you have to implement a toast notification.</para></remarks>
|
||
<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>Tizen</term><description>Tizen 3.0</description></item>
|
||
<item><term>Windows UWP</term><description>Windows 10 Mobile</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.Phone.Devices.Notification.VibrationDevice.GetDefault">
|
||
<summary>
|
||
Gets an instance of the VibrationDevice class.
|
||
</summary>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:InTheHand.Phone.Devices.Notification.VibrationDevice.Vibrate(System.TimeSpan)">
|
||
<summary>
|
||
Vibrates the phone for the specified duration (from 0 to 5 seconds).
|
||
</summary>
|
||
<param name="duration">The duration (from 0 to 5 seconds) for which the phone vibrates. A value that is less than 0 or greater than 5 raises an exception. Ignored on iOS.</param>
|
||
</member>
|
||
<member name="M:InTheHand.Phone.Devices.Notification.VibrationDevice.Cancel">
|
||
<summary>
|
||
Stops the vibration of the phone.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.Phone.System.SystemProtection">
|
||
<summary>
|
||
Provides information related to system protection.
|
||
<para><b>Supported on Windows Phone, Android and iOS only.</b></para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.Phone.System.SystemProtection.ScreenLocked">
|
||
<summary>
|
||
Gets a value that indicates whether the screen is locked.
|
||
</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.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.Pickers.FileOpenPicker">
|
||
<summary>
|
||
Represents a UI element that lets the user choose and open files.
|
||
</summary>
|
||
<remarks>
|
||
<para/><list type="table">
|
||
<listheader><term>Platform</term><description>Version supported</description></listheader>
|
||
<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 10 Mobile 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.Pickers.FileOpenPicker.PickSingleFileAsync">
|
||
<summary>
|
||
Shows the file picker so that the user can pick one file.
|
||
</summary>
|
||
<returns>When the call to this method completes successfully, it returns a <see cref="T:InTheHand.Storage.StorageFile"/> object that represents the file that the user picked.</returns>
|
||
</member>
|
||
<member name="P:InTheHand.Storage.Pickers.FileOpenPicker.FileTypeFilter">
|
||
<summary>
|
||
Gets the collection of file types that the file open picker displays.
|
||
</summary>
|
||
</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.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.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.Power.BatteryStatus">
|
||
<summary>
|
||
Indicates the status of the battery.
|
||
</summary>
|
||
<seealso cref="T:InTheHand.System.Power.PowerManager"/>
|
||
</member>
|
||
<member name="F:InTheHand.System.Power.BatteryStatus.NotPresent">
|
||
<summary>
|
||
The battery or battery controller is not present.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.System.Power.BatteryStatus.Discharging">
|
||
<summary>
|
||
The battery is discharging.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.System.Power.BatteryStatus.Idle">
|
||
<summary>
|
||
The battery is idle.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.System.Power.BatteryStatus.Charging">
|
||
<summary>
|
||
The battery is charging.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.System.Power.EnergySaverStatus">
|
||
<summary>
|
||
Specifies the status of battery saver.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.System.Power.EnergySaverStatus.Disabled">
|
||
<summary>
|
||
Battery saver is off permanently or the device is plugged in.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.System.Power.EnergySaverStatus.Off">
|
||
<summary>
|
||
Battery saver is off now, but ready to turn on automatically.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.System.Power.EnergySaverStatus.On">
|
||
<summary>
|
||
Battery saver is on. Save energy where possible.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.System.Power.PowerManager">
|
||
<summary>
|
||
Provides information about the status of the device's battery.
|
||
</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>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 10 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.Power.PowerManager.BatteryStatus">
|
||
<summary>
|
||
Gets the device's battery status.
|
||
</summary>
|
||
<remarks>The device's battery status.</remarks>
|
||
</member>
|
||
<member name="P:InTheHand.System.Power.PowerManager.EnergySaverStatus">
|
||
<summary>
|
||
Gets battery saver status, indicating when to save energy.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.System.Power.PowerManager.PowerSupplyStatus">
|
||
<summary>
|
||
Gets the device's power supply status.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.System.Power.PowerManager.RemainingChargePercent">
|
||
<summary>
|
||
Gets the total percentage of charge remaining from all batteries connected to the device.
|
||
<para>Not supported for Windows 8.1 apps deployed via the public Windows Store.</para>
|
||
</summary>
|
||
<value>The total percentage of charge remaining from all batteries connected to the device.</value>
|
||
</member>
|
||
<member name="E:InTheHand.System.Power.PowerManager.RemainingChargePercentChanged">
|
||
<summary>
|
||
Occurs when <see cref="P:InTheHand.System.Power.PowerManager.RemainingChargePercent"/>changes.
|
||
</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>Tizen</term><description>Tizen 3.0</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.System.Power.PowerManager.RemainingDischargeTime">
|
||
<summary>
|
||
Gets a value that estimates how long is left until the device's battery is fully discharged.
|
||
<para>Not supported for apps deployed on Windows 8.1 from the public Windows Store.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.System.Power.PowerSupplyStatus">
|
||
<summary>
|
||
Represents the device's power supply status.
|
||
</summary>
|
||
<remarks>An Inadequate status occurs when the power supply is present, but the charge rate is negative.
|
||
For example, the device is plugged in, but it’s losing charge.</remarks>
|
||
</member>
|
||
<member name="F:InTheHand.System.Power.PowerSupplyStatus.NotPresent">
|
||
<summary>
|
||
The device has no power supply.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.System.Power.PowerSupplyStatus.Inadequate">
|
||
<summary>
|
||
The device has an inadequate power supply.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.System.Power.PowerSupplyStatus.Adequate">
|
||
<summary>
|
||
The device has an adequate power supply.
|
||
</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.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.UI.ApplicationSettings.SettingsActivity">
|
||
<summary>
|
||
Exposes standard Android preferences screens
|
||
</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.Notifications.ScheduledToastNotification">
|
||
<summary>
|
||
Contains the definition of the toast notification that will display at the scheduled 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>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.1 or later</description></item></list>
|
||
</remarks>
|
||
<seealso cref="T:InTheHand.UI.Notifications.ToastNotificationCreator"/>
|
||
</member>
|
||
<member name="P:InTheHand.UI.Notifications.ScheduledToastNotification.DeliveryTime">
|
||
<summary>
|
||
Gets the time that this toast notification is scheduled to be displayed.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.UI.Notifications.ScheduledToastNotification.Group">
|
||
<summary>
|
||
Gets or sets the group identifier for the notification.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.UI.Notifications.ScheduledToastNotification.SuppressPopup">
|
||
<summary>
|
||
Gets or sets whether a toast's pop-up UI is displayed on the user's screen.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.UI.Notifications.ScheduledToastNotification.Tag">
|
||
<summary>
|
||
Gets or sets the unique identifier of this notification within the notification Group.
|
||
</summary>
|
||
</member>
|
||
<member name="T:InTheHand.UI.Notifications.ToastNotification">
|
||
<summary>
|
||
Defines the content, associated metadata and events, and expiration time of a toast notification.
|
||
</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>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.1 or later</description></item></list>
|
||
</remarks>
|
||
<seealso cref="T:InTheHand.UI.Notifications.ToastNotificationCreator"/>
|
||
</member>
|
||
<member name="P:InTheHand.UI.Notifications.ToastNotification.Group">
|
||
<summary>
|
||
Gets or sets the group identifier for the notification.
|
||
</summary>
|
||
<value>The group identifier for the notification.</value>
|
||
<remarks>Not used on macOS. On iOS this maps to the CategoryIdentifier property.</remarks>
|
||
</member>
|
||
<member name="P:InTheHand.UI.Notifications.ToastNotification.SuppressPopup">
|
||
<summary>
|
||
Gets or sets whether a toast's pop-up UI is displayed on the user's screen.
|
||
</summary>
|
||
</member>
|
||
<member name="P:InTheHand.UI.Notifications.ToastNotification.Tag">
|
||
<summary>
|
||
Gets or sets the unique identifier of this notification within the notification Group.
|
||
</summary>
|
||
<remarks>
|
||
On iOS this maps to the ThreadIdentifier property and on macOS the Identifier property.</remarks>
|
||
</member>
|
||
<member name="T:InTheHand.UI.Notifications.ToastNotificationCreator">
|
||
<summary>
|
||
Simplifies creation of toasts without the need to build XML documents.
|
||
</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>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.1 or later</description></item></list>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:InTheHand.UI.Notifications.ToastNotificationCreator.CreateToastNotification(System.String,System.String)">
|
||
<summary>
|
||
Creates a toast notification with the required values.
|
||
</summary>
|
||
<param name="content">Text content.</param>
|
||
<param name="title">Toast title.</param>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:InTheHand.UI.Notifications.ToastNotificationCreator.CreateScheduledToastNotification(System.String,System.String,System.DateTimeOffset)">
|
||
<summary>
|
||
Creates a scheduled toast notification with the required values.
|
||
</summary>
|
||
<param name="content">Text content.</param>
|
||
<param name="title">Toast title.</param>
|
||
<param name="deliveryTime">When to display the toast.</param>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="T:InTheHand.UI.Notifications.ToastNotificationManager">
|
||
<summary>
|
||
Creates ToastNotifier objects which let you display toast notifications.
|
||
</summary>
|
||
</member>
|
||
<member name="M:InTheHand.UI.Notifications.ToastNotificationManager.CreateToastNotifierForApplication">
|
||
<summary>
|
||
Creates and initializes a new instance of the ToastNotifier, which lets you display toast notifications.
|
||
</summary>
|
||
<returns></returns>
|
||
<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>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.1 or later</description></item></list>
|
||
</remarks>
|
||
</member>
|
||
<member name="T:InTheHand.UI.Notifications.ToastNotifier">
|
||
<summary>
|
||
Raises a toast notification to the specific app to which the ToastNotifier is bound.
|
||
This class also lets you schedule and remove toast notifications.
|
||
</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>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.ToastNotifier.Show(InTheHand.UI.Notifications.ToastNotification)">
|
||
<summary>
|
||
Shows a toast notification.
|
||
</summary>
|
||
<param name="notification">The object that supplies the new XML definition for the toast.</param>
|
||
</member>
|
||
<member name="M:InTheHand.UI.Notifications.ToastNotifier.Hide(InTheHand.UI.Notifications.ToastNotification)">
|
||
<summary>
|
||
Hides a toast notification.
|
||
</summary>
|
||
<param name="notification">The object that supplies the new XML definition for the toast.</param>
|
||
</member>
|
||
<member name="M:InTheHand.UI.Notifications.ToastNotifier.AddToSchedule(InTheHand.UI.Notifications.ScheduledToastNotification)">
|
||
<summary>
|
||
Adds a <see cref="T:InTheHand.UI.Notifications.ScheduledToastNotification"/> for later display.
|
||
</summary>
|
||
<param name="scheduledToast">The scheduled toast notification, which includes its content and timing instructions.</param>
|
||
</member>
|
||
<member name="M:InTheHand.UI.Notifications.ToastNotifier.RemoveFromSchedule(InTheHand.UI.Notifications.ScheduledToastNotification)">
|
||
<summary>
|
||
Cancels the scheduled display of a specified <see cref="T:InTheHand.UI.Notifications.ScheduledToastNotification"/>.
|
||
</summary>
|
||
<param name="scheduledToast">The scheduled toast notification, which includes its content and timing instructions.</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.Placement">
|
||
<summary>
|
||
Specifies where the context menu should be positioned relative to the selection rectangle
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.UI.Popups.Placement.Default">
|
||
<summary>
|
||
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.UI.Popups.Placement.Above">
|
||
<summary>
|
||
Place the context menu above the selection rectangle.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.UI.Popups.Placement.Below">
|
||
<summary>
|
||
Place the context menu below the selection rectangle.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.UI.Popups.Placement.Left">
|
||
<summary>
|
||
Place the context menu to the left of the selection rectangle.
|
||
</summary>
|
||
</member>
|
||
<member name="F:InTheHand.UI.Popups.Placement.Right">
|
||
<summary>
|
||
Place the context menu to the right of the selection rectangle.
|
||
</summary>
|
||
</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.StatusBar">
|
||
<summary>
|
||
Provides methods and properties for interacting with the status bar on a window (app view).
|
||
</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>Windows UWP</term><description>Windows 10 Mobile</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.StatusBar.GetForCurrentView">
|
||
<summary>
|
||
Gets the status bar for the current window (app view).
|
||
</summary>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="P:InTheHand.UI.ViewManagement.StatusBar.ProgressIndicator">
|
||
<summary>
|
||
Gets the progress indicator for the status bar.
|
||
</summary>
|
||
<value>The progress indicator for the status bar.</value>
|
||
</member>
|
||
<member name="M:InTheHand.UI.ViewManagement.StatusBar.ShowAsync">
|
||
<summary>
|
||
Shows the status bar.
|
||
</summary>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:InTheHand.UI.ViewManagement.StatusBar.HideAsync">
|
||
<summary>
|
||
Hides the status bar.
|
||
</summary>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="T:InTheHand.UI.ViewManagement.StatusBarProgressIndicator">
|
||
<summary>
|
||
Provides methods and properties for interacting with the progress indicator on the status bar on a window (app view).
|
||
</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>Windows UWP</term><description>Windows 10 Mobile</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.StatusBarProgressIndicator.HideAsync">
|
||
<summary>
|
||
Hides the progress indicator.
|
||
</summary>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="M:InTheHand.UI.ViewManagement.StatusBarProgressIndicator.ShowAsync">
|
||
<summary>
|
||
Shows the progress indicator.
|
||
</summary>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="P:InTheHand.UI.ViewManagement.StatusBarProgressIndicator.ProgressValue">
|
||
<summary>
|
||
Gets or sets a value representing progress in the range 0 to 1.
|
||
</summary>
|
||
<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 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.ViewManagement.StatusBarProgressIndicator.Text">
|
||
<summary>
|
||
Gets or sets the text label displayed on the progress indicator.
|
||
</summary>
|
||
</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:InTheHand.UUIDExtensions">
|
||
<summary>
|
||
Helper class for <see cref="T:Java.Util.UUID"/>.
|
||
</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></list>
|
||
</remarks>
|
||
</member>
|
||
<member name="M:InTheHand.UUIDExtensions.ToGuid(Java.Util.UUID)">
|
||
<summary>
|
||
Converts a <see cref="T:Java.Util.UUID"/> to a .NET <see cref="T:System.Guid"/> .
|
||
</summary>
|
||
<param name="uuid"></param>
|
||
<returns></returns>
|
||
</member>
|
||
<member name="T:System.Collections.Generic.InTheHandListExtensions">
|
||
<summary>
|
||
Extensions for <see cref="T:System.Collections.Generic.List`1"/>.
|
||
</summary>
|
||
</member>
|
||
<member name="M:System.Collections.Generic.InTheHandListExtensions.AsReadOnly``1(System.Collections.Generic.List{``0})">
|
||
<summary>
|
||
Returns a read-only <see cref="T:System.Collections.ObjectModel.ReadOnlyCollection`1"/> wrapper for the current collection.
|
||
</summary>
|
||
<typeparam name="T"></typeparam>
|
||
<param name="list"></param>
|
||
<returns>An object that acts as a read-only wrapper around the current <see cref="T:System.Collections.Generic.List`1"/>.</returns>
|
||
</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>
|