RadialControllerMenuItem Class

Reference

Definition

Namespace:: Windows.UI.Input

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Edit

Represents a single custom tool from the RadialController menu.

public ref class RadialControllerMenuItem sealed

/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 196608)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class RadialControllerMenuItem final

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 196608)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class RadialControllerMenuItem

Public NotInheritable Class RadialControllerMenuItem

Inheritance: Object Platform::Object IInspectable RadialControllerMenuItem

Attributes: ContractVersionAttribute MarshalingBehaviorAttribute

Windows requirements

Device family	Windows 10 Anniversary Edition (introduced in 10.0.14393.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v3.0)

Examples

In this example, we add a custom tool (Sample) with a standard icon to the Surface Dial menu.

First, we get a reference to the RadialController object for the Surface Dial (myController) by calling CreateForCurrentView.
We then create an instance of a RadialControllerMenuItem (myItem) by calling RadialControllerMenuItem.CreateFromIcon.
Finally, we append that item to the collection of menu items.

public sealed partial class MainPage : Page
 {
     RadialController myController;

     public MainPage()
     {
         this.InitializeComponent();
         // Create a reference to the RadialController.
         myController = RadialController.CreateForCurrentView();

         // Create an icon for the custom tool.
         RandomAccessStreamReference icon =
           RandomAccessStreamReference.CreateFromUri(
             new Uri("ms-appx:///Assets/StoreLogo.png"));

         // Create a menu item for the custom tool.
         RadialControllerMenuItem myItem =
           RadialControllerMenuItem.CreateFromIcon("Sample", icon);

         // Add the custom tool to the RadialController menu.
         myController.Menu.Items.Add(myItem);

         // Declare input handlers for the RadialController.
         myController.ButtonClicked += MyController_ButtonClicked;
         myController.RotationChanged += MyController_RotationChanged;
     }
 }

Remarks

Version history

Windows version	SDK version	Value added
1703	15063	CreateFromFontGlyph(String,String,String)
1703	15063	CreateFromFontGlyph(String,String,String,Uri)

Properties

DisplayText	Gets the text string of the custom tool on the RadialController menu.
Tag	Gets or sets an object used to identify custom tools on the RadialController menu.

Methods

CreateFromFontGlyph(String, String, String, Uri)	Creates a custom tool (using the specified text string and font glyph) on the RadialController menu.
CreateFromFontGlyph(String, String, String)	Creates a custom tool (using the specified text string and font glyph) on the RadialController menu.
CreateFromIcon(String, RandomAccessStreamReference)	Creates a custom tool (using the specified text string and custom icon) on the RadialController menu.
CreateFromKnownIcon(String, RadialControllerMenuKnownIcon)	Creates a custom tool (using the specified text string and system icon) on the RadialController menu.

Events

Invoked

Occurs when a custom tool is selected from the RadialController menu.

Applies to

Jaa