SaveRingtoneTask Class

Article
11/23/2015
2 minutes to read

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

Enables an application to launch the ringtones application. Use the SaveRingtoneTask to allow users to save a ringtone from your application to the system ringtones list.

Inheritance Hierarchy

System..::.Object
Microsoft.Phone.Tasks..::.ChooserBase<(Of <(TaskEventArgs>)>)
Microsoft.Phone.Tasks..::.SaveRingtoneTask

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

Syntax

Public NotInheritable Class SaveRingtoneTask _
    Inherits ChooserBase(Of TaskEventArgs)

public sealed class SaveRingtoneTask : ChooserBase<TaskEventArgs>

<SaveRingtoneTask .../>

The SaveRingtoneTask type exposes the following members.

Constructors

	Name	Description
	SaveRingtoneTask	Initializes a new instance of the SaveRingtoneTask class.

Top

Properties

	Name	Description
	DisplayName	Name used to identify the ringtone in the picker.
	IsShareable	Flag that indicates whether the ringtone should be accessible to other applications.
	Source	File path to the local copy of the audio file to be added to the ringtone directory.
	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 ringtones 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

Important Note:
Ringtone files must be of type MP3 or WMA. Ringtone files must be less than 40 seconds in length. Ringtone files must not have digital rights management (DRM) protection. Ringtone files must be less than 1 MB in size.

For more information, see the Ringtones sample. Also see How to use the save ringtone task for Windows Phone 8 for an example of using the SaveRingtoneTask.

Version Information

Windows Phone OS

Supported in: 8.1, 8.0, 7.1

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.