WalletItemCustomProperty
WalletItemCustomProperty
WalletItemCustomProperty
WalletItemCustomProperty
Class
Definition
Defines a custom property on a wallet item. Apps can show data in the details view or back of card view of the item.
public : sealed class WalletItemCustomProperty : IWalletItemCustomPropertypublic sealed class WalletItemCustomProperty : IWalletItemCustomPropertyPublic NotInheritable Class WalletItemCustomProperty Implements IWalletItemCustomProperty// You can use this class in JavaScript.
- Attributes
| Device family |
Windows 10 (introduced v10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v1)
|
Remarks
WalletItemCustomProperty values are stored in the DisplayProperties property of a WalletItem. In addition to the basic data (Name and Value ) a WalletItemCustomProperty object has other properties that influence how the property appears in the default wallet UI (for example SummaryViewPosition, DetailViewPosition ).
Constructors
WalletItemCustomProperty(String, String) WalletItemCustomProperty(String, String) WalletItemCustomProperty(String, String) WalletItemCustomProperty(String, String)
Initializes a new instance of the WalletItemCustomProperty class.
public : WalletItemCustomProperty(PlatForm::String name, PlatForm::String value)public WalletItemCustomProperty(String name, String value)Public Sub New(name As String, value As String)// You can use this method in JavaScript.
- name
- PlatForm::String String String String
The custom property label. Sets the initial Name value.
- value
- PlatForm::String String String String
The value of the property. Sets the initial Value value.
Properties
AutoDetectLinks AutoDetectLinks AutoDetectLinks AutoDetectLinks
Gets or sets whether this WalletItemCustomProperty is entity-extracted and actionable upon display.
public : PlatForm::Boolean AutoDetectLinks { get; set; }public bool AutoDetectLinks { get; set; }Public ReadWrite Property AutoDetectLinks As bool// You can use this property in JavaScript.
- Value
- PlatForm::Boolean bool bool bool
true if the WalletItemCustomProperty is entity-extracted and actionable upon display; Otherwise, false.
Remarks
Entity-extracted is a term for the automatic behavior that can match strings in data to certain patterns, and automatically generate an appropriate action/behavior for that item in the UI. This technique is commonly used in e-mail applications, and is also used here for the UI logic of a wallet item display. For example, a 10-digit string where each character is a number 0-9 can be entity-extracted to represent a phone number, and the action associated is to initiate a call to that number. Because there can be false matches to the patterns, the default value is false, but if you know what the data and matching behavior is in your WalletItemCustomProperty and you want entity-extracted behavior, set this property true.
- See Also
DetailViewPosition DetailViewPosition DetailViewPosition DetailViewPosition
Gets or sets the optional position of this property when shown in the wallet item's detail view.
public : WalletDetailViewPosition DetailViewPosition { get; set; }public WalletDetailViewPosition DetailViewPosition { get; set; }Public ReadWrite Property DetailViewPosition As WalletDetailViewPosition// You can use this property in JavaScript.
- Value
- WalletDetailViewPosition WalletDetailViewPosition WalletDetailViewPosition WalletDetailViewPosition
The optional position of this property when shown in the wallet item's detail view, as a value of the enumeration. The default is Hidden.
- See Also
Name Name Name Name
Gets or sets the custom property label.
public : PlatForm::String Name { get; set; }public string Name { get; set; }Public ReadWrite Property Name As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The custom property label.
Remarks
Unlike the key for the DisplayProperties collection, the Name value of a WalletItemCustomProperty object is intended for user UI. Setting the value that's reported by Name is a required parameter when you construct a new WalletItemCustomProperty (see WalletItemCustomProperty constructor ). In most cases you won't be setting the Name property of an existing WalletItemCustomProperty, as opposed to constructing a new one.
SummaryViewPosition SummaryViewPosition SummaryViewPosition SummaryViewPosition
Gets or sets the optional position of this property when shown in the summary view for a wallet item.
public : WalletSummaryViewPosition SummaryViewPosition { get; set; }public WalletSummaryViewPosition SummaryViewPosition { get; set; }Public ReadWrite Property SummaryViewPosition As WalletSummaryViewPosition// You can use this property in JavaScript.
- Value
- WalletSummaryViewPosition WalletSummaryViewPosition WalletSummaryViewPosition WalletSummaryViewPosition
The optional position of this property when shown in the summary view for a wallet item, as a value of the enumeration. The default is Hidden.
- See Also
Value Value Value Value
Gets or sets the custom property value.
public : PlatForm::String Value { get; set; }public string Value { get; set; }Public ReadWrite Property Value As string// You can use this property in JavaScript.
- Value
- PlatForm::String string string string
The custom property value.
Remarks
Setting the value that's reported by Value is a required parameter when you construct a new WalletItemCustomProperty (see WalletItemCustomProperty constructor ). In most cases you won't be setting the Value property of an existing WalletItemCustomProperty, as opposed to constructing a new one.