RadialControllerMenuItem.CreateFromKnownIcon Method

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

Creates a custom tool (using the specified text string and system icon) on the RadialController menu.

public:
 static RadialControllerMenuItem ^ CreateFromKnownIcon(Platform::String ^ displayText, RadialControllerMenuKnownIcon value);

 static RadialControllerMenuItem CreateFromKnownIcon(winrt::hstring const& displayText, RadialControllerMenuKnownIcon const& value);

public static RadialControllerMenuItem CreateFromKnownIcon(string displayText, RadialControllerMenuKnownIcon value);

function createFromKnownIcon(displayText, value)

Public Shared Function CreateFromKnownIcon (displayText As String, value As RadialControllerMenuKnownIcon) As RadialControllerMenuItem

Parameters

displayText: String
Platform::String

winrt::hstring

The text string to display for the custom tool.

value: RadialControllerMenuKnownIcon

The system icon to display for the custom tool.

Returns

RadialControllerMenuItem

The custom tool.

Remarks

RadialController menu operations, including CreateFromKnownIcon, CreateFromIcon, CreateFromFontGlyph, CreateFromFontGlyph, ResetToDefaultMenuItems, SetDefaultMenuItems, and TrySelectDefaultMenuItem, should be performed on the UI thread. Doing so in a background worker thread can cause issues with event handlers on the UI thread.

UX guidelines for the Surface Dial recommend the following:

Text

Names should be short to fit inside the central circle of the wheel menu
Names should clearly identify the primary action (a complementary action can be implied)
Scroll indicates the effect of both rotation directions
Undo specifies a primary action, but redo (the complementary action) can be inferred and easily discovered by the user

Applies to