JumpListItemBackgroundConverter JumpListItemBackgroundConverter JumpListItemBackgroundConverter Class

Provides the appropriate background Brush for elements in the item template of a jump list to bind to. The Brush reflects the current theme and accent color, and it's also used to shade empty-group jump list items. By default, the Brush matches built-in apps, but you can override that to suit your design needs using the Enabled and Disabled properties.

Syntax

Declaration

public sealed class JumpListItemBackgroundConverterpublic sealed class JumpListItemBackgroundConverterPublic NotInheritable Class JumpListItemBackgroundConverter

Inheritance Hierarchy

Constructors summary

Initializes a new instance of the JumpListItemBackgroundConverter class.

Properties summary

Gets or sets the brush to be used for the background when the group is empty and the jump list item is disabled.

Identifies the Disabled dependency property.

Gets or sets the brush to be used for the background when the group is not empty and the jump list item is enabled.

Identifies the Enabled dependency property.

Methods summary

Returns the enabled brush if the item is not empty, otherwise returns the disabled brush.

Modifies the target data before passing it to the source object.

Constructors

  • JumpListItemBackgroundConverter()
    JumpListItemBackgroundConverter()
    JumpListItemBackgroundConverter()
    JumpListItemBackgroundConverter()

    Initializes a new instance of the JumpListItemBackgroundConverter class.

    public JumpListItemBackgroundConverter()public New()Public Sub New()public JumpListItemBackgroundConverter()

Properties

  • Disabled
    Disabled
    Disabled
    Disabled

    Gets or sets the brush to be used for the background when the group is empty and the jump list item is disabled.

    public Brush Disabled { get; set; }public Brush Disabled { get; set; }Public ReadWrite Property Disabled As Brushpublic Brush Disabled { get; set; }

    Property Value

    • The brush to be used for the background when the group is empty and the jump list item is disabled.

  • DisabledProperty
    DisabledProperty
    DisabledProperty
    DisabledProperty

    Identifies the Disabled dependency property.

    public static DependencyProperty DisabledProperty { get; }public static DependencyProperty DisabledProperty { get; }Public Static ReadOnly Property DisabledProperty As DependencyPropertypublic static DependencyProperty DisabledProperty { get; }

    Property Value

  • Enabled
    Enabled
    Enabled
    Enabled

    Gets or sets the brush to be used for the background when the group is not empty and the jump list item is enabled.

    public Brush Enabled { get; set; }public Brush Enabled { get; set; }Public ReadWrite Property Enabled As Brushpublic Brush Enabled { get; set; }

    Property Value

    • The brush to be used for the background when the group is not empty and the jump list item is enabled.

  • EnabledProperty
    EnabledProperty
    EnabledProperty
    EnabledProperty

    Identifies the Enabled dependency property.

    public static DependencyProperty EnabledProperty { get; }public static DependencyProperty EnabledProperty { get; }Public Static ReadOnly Property EnabledProperty As DependencyPropertypublic static DependencyProperty EnabledProperty { get; }

    Property Value

Methods

  • Convert(Object, TypeName, Object, String)
    Convert(Object, TypeName, Object, String)
    Convert(Object, TypeName, Object, String)
    Convert(Object, TypeName, Object, String)

    Returns the enabled brush if the item is not empty, otherwise returns the disabled brush.

    public object Convert(Object value, TypeName targetType, Object parameter, String language)public object Convert(Object value, TypeName targetType, Object parameter, String language)Public Function Convert(value As Object, targetType As TypeName, parameter As Object, language As String) As objectpublic object Convert(Object value, TypeName targetType, Object parameter, String language)

    Parameters

    • value
      System.Object
      System.Object
      System.Object

      The source data being passed to the target.

    • targetType

      The TypeName of data expected by the target dependency property.

    • parameter
      System.Object
      System.Object
      System.Object

      An optional parameter to be used in the converter logic.

    • language
      System.String
      System.String
      System.String

      The culture of the conversion.

    Returns

    • object
      object
      object

      The enabled brush if the item is not empty, otherwise the disabled brush.

  • ConvertBack(Object, TypeName, Object, String)
    ConvertBack(Object, TypeName, Object, String)
    ConvertBack(Object, TypeName, Object, String)
    ConvertBack(Object, TypeName, Object, String)

    Modifies the target data before passing it to the source object.

    public object ConvertBack(Object value, TypeName targetType, Object parameter, String language)public object ConvertBack(Object value, TypeName targetType, Object parameter, String language)Public Function ConvertBack(value As Object, targetType As TypeName, parameter As Object, language As String) As objectpublic object ConvertBack(Object value, TypeName targetType, Object parameter, String language)

    Parameters

    • value
      System.Object
      System.Object
      System.Object

      The target data being passed to the source.

    • targetType

      The TypeName of data expected by the source object.

    • parameter
      System.Object
      System.Object
      System.Object

      An optional parameter to be used in the converter logic.

    • language
      System.String
      System.String
      System.String

      The culture of the conversion.

    Returns

    • object
      object
      object

      The value to be passed to the source object.

Device family

Windows 10 (introduced v10.0.10240.0)

API contract

Windows.Foundation.UniversalApiContract (introduced v1)

Attributes

Windows.Foundation.Metadata.ActivatableAttribute
Windows.Foundation.Metadata.ContractVersionAttribute
Windows.Foundation.Metadata.MarshalingBehaviorAttribute
Windows.Foundation.Metadata.StaticAttribute
Windows.Foundation.Metadata.ThreadingAttribute
Windows.Foundation.Metadata.WebHostHiddenAttribute

Details

Assembly

Windows.UI.Xaml.Controls.Primitives.dll