PhotoChooserTask Class

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

Allows an application to launch the Photo Chooser application. Use this to allow users to select a photo.

Inheritance Hierarchy

System..::.Object
Microsoft.Phone.Tasks..::.ChooserBase<(Of <(PhotoResult>)>)
Microsoft.Phone.Tasks..::.PhotoChooserTask

Namespace: Microsoft.Phone.Tasks
Assembly: Microsoft.Phone (in Microsoft.Phone.dll)
XMLNS for XAML: Not mapped to an xmlns.

Syntax

Public NotInheritable Class PhotoChooserTask _
    Inherits ChooserBase(Of PhotoResult)
public sealed class PhotoChooserTask : ChooserBase<PhotoResult>
<PhotoChooserTask .../>

The PhotoChooserTask type exposes the following members.

Constructors

Name Description
PhotoChooserTask Initializes a new instance of the Photo Chooser application.

Top

Properties

Name Description
PixelHeight Gets or sets the maximum height and the height component of the aspect ratio for a cropping region set by the user during the photo choosing process.
PixelWidth Gets or sets the maximum width and the width component of the aspect ratio for a cropping region set by the user during the photo choosing process.
ShowCamera Gets or sets whether the user is presented with a button for launching the camera during the photo choosing process.
TaskEventArgs The EventArgs for the Completed event. (Inherited from ChooserBase<(Of <(TTaskEventArgs>)>).)

Top

Methods

Name Description
Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Finalize Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
FireCompleted Raises the Completed event. (Inherited from ChooserBase<(Of <(TTaskEventArgs>)>).)
GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
GetType Gets the Type of the current instance. (Inherited from Object.)
MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Show Shows the Photo Chooser application. (Overrides ChooserBase<(Of <(TTaskEventArgs>)>)..::.Show()()().)
ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Events

Name Description
Completed Occurs when a Chooser task is completed. (Inherited from ChooserBase<(Of <(TTaskEventArgs>)>).)

Top

Remarks

Launch the Photo Chooser application by calling the Show method of the PhotoChooserTask object. Obtain the result of the chooser operation by handling the Completed event.

Important Note:

On Windows Phone, your application may be deactivated while the Photo Chooser application is in the foreground. To ensure that your application receives the result of the PhotoChooserTask, the object must be declared with class scope within the PhoneApplicationPage class and you must call the chooser constructor and assign the Completed event delegate within the page’s constructor. For more information about how to handle the activation and deactivation of your application, seeApp activation and deactivation for Windows Phone 8.

Version Information

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Platforms

Windows Phone

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.Phone.Tasks Namespace

Other Resources

Launchers and Choosers for Windows Phone 8

How to use the photo chooser task for Windows Phone 8