Jump to: navigation, search

Difference between revisions of "Converters In Xamarin"


Line 1: Line 1:
=Converters in Xamarin=
 
 
This page lists all currently available converters for customizing Xamarin XAML. '''This Page is WIP!!!'''
 
This page lists all currently available converters for customizing Xamarin XAML. '''This Page is WIP!!!'''
  
Line 52: Line 51:
 
|-  
 
|-  
 
| IntToColorConverter || style="text-align: center;" | ✗ || Converts an '''integer''' value to a '''color'''. If the value cannot be interpreted, the converter tries to parse the parameter as a ''color'' to return it. If everything fails, ''transparent'' is returned.
 
| IntToColorConverter || style="text-align: center;" | ✗ || Converts an '''integer''' value to a '''color'''. If the value cannot be interpreted, the converter tries to parse the parameter as a ''color'' to return it. If everything fails, ''transparent'' is returned.
 +
|-
 +
| ItemCountToBoolConverter || style="text-align: center;" | ✗ || This converter has a '''property''' to set the '''boolean return value''', called ''LesserThanReturnValue''. This property-value will be returned if the given value is '''smaller than or equal to''' the threshold (parameter, defaults to 0). If the value is '''bigger than''' the threshold, the '''inverted''' ''LesserThanReturnValue'' will be returned.<br/>
 +
In any other case (like the value cannot be interpreted), ''false'' is returned, so it's a good idea to set the converter's property in a way that the return is only ''true'' if you need it.
 +
|-
 +
| ItemCountToOverflowConverter || style="text-align: center;" | ✗ || Creates a '''human-readable text''' indicating '''how many items are available'''. The value will be interpreted as the '''total item count''' and the parameter as '''overflow threshold''' (defaults to 99). <br/>If there are more items than the overflow, the overflow value with a + sign will be returned (e.g. 99+). If not, the value itself will be returned. If everything fails, ''null'' is returned.
 +
|-
 +
| NullToBoolConverter || style="text-align: center;" | ✓ || ''Null'' or an '''empty string''' value get converted to ''true'', and everything else to ''false''.
 +
|-
 +
| NullToInvertedBoolConverter || style="text-align: center;" | ✓ || ''Null'' or an '''empty string''' value get converted to ''false'', and everything else to ''true''.
 +
|-
 +
| PathToImageSourceValueConverter || style="text-align: center;" | ✓ || Reads the '''path''' provided as parameter and creates an '''image source''' from it.
 
|}
 
|}
  
 
===Usage===
 
===Usage===
 
<Shortly describe how to use the activity ...>
 
<Shortly describe how to use the activity ...>

Revision as of 14:29, 1 August 2019

This page lists all currently available converters for customizing Xamarin XAML. This Page is WIP!!!

Converter 2-Way Description
BooleanConverter Interprets the boolean value and returns it. If the value cannot be interpreted, false is returned.
BooleanInvertConverter Interprets and converts a boolean into its inverted value. If the value cannot be interpreted, false is returned.
BooleanToFontAttributeConverter Converts a boolean into a [font attribute] value. In detail, if the value is true, the parameter is interpreted (Bold, Italic, None) and returned. The default returned font-attribute is None.
ByteToImageSourceValueConverter Converts a byte stream value into an image source.
ChildAreaTemplateConverter Returns a ChildAreaTemplate from a ContentViewModel or null if the ViewModel cannot be interpreted.
ChildItemSelectionModeToSfListViewSelectionModeConverter Converts a ChildItemSelectionMode to [Syncfusion's ListViewSelectionMode]. Default is "Single".
ClassificationToBoolConverter Returns a boolean indicating whether the given ContentViewModel is successfully classified.
ContainsToBoolConverter Checks if the delivered value is contained within a collection of values (delivered in the parameter, seperated with |). If the value is contained, true will be returned, else false. The functionality is similar to the ContainsToVisibilityConverter in the WinX project.
ContainsToInvertedBoolConverter Same as the ContainsToBoolConverter, but with inverted output. The functionality is similar to the ContainsToVisibilityConverter in the WinX project.
ContentAreaTeamplateConverter This converter is not yet finished and just returns the UBIKContentArea if the value is a ContentViewModel.
DateTimeOffsetToDateConverter Converts a DateTimeOffset to the correct DateTime. If the value cannot be interpreted, a new DateTime, generated from the device's current time (DateTime.Now) is returned.
DateTimeToFromNowStringConverter Returns a DateTime into a human-readable and easily understandable string message (the last applying one will be taken):
  • Less than 5 minutes in the past: Just now
  • Less than 10 minutes in the past: A few minutes ago
  • Less than 1 hour in the past: An hour ago
  • Less than 23 Hours in the past: Some hours ago
  • Less than 1 day in the past: Yesterday
  • More than 1 day in the past: The DateTime value formatted according to the device's localization rules.
  • Not interpretable: ???
DebugConverter A converter returning the given value for debug reasons.
DistanceToStringConverter Returns the given value interpreted as length. Values are returned in kilometers with two comma digits (e.g. 2.84km), values smaller than 1km are returned as meters and NaN will be returned as infinity. If the value cannot be interpreted, an empty string will be returned.
EqualityToBoolConverter Returns true if the given value and parameter are equal to each other, false otherwise.
EqualityToInvertedBoolConverter Returns true if the given value and parameter are not equal to each other, false otherwise.
SelectionChangedEventArgsConverter Converts an Syncfusion ItemSelectionChangedEventArgs to a ListSelectionChangedEventArgs. The use-case of this converter is highly specific.
FilterCriterionToValueConverter Converts a FilterCriterion to its value. The functionality is similar to UWP's FilterCriterionToValueConverter.
GuidPropertyValueConverter Returns the first item of the parameter's Source-ViewModel that matches the given GUID value. If none is found, null is returned.
IntToColorConverter Converts an integer value to a color. If the value cannot be interpreted, the converter tries to parse the parameter as a color to return it. If everything fails, transparent is returned.
ItemCountToBoolConverter This converter has a property to set the boolean return value, called LesserThanReturnValue. This property-value will be returned if the given value is smaller than or equal to the threshold (parameter, defaults to 0). If the value is bigger than the threshold, the inverted LesserThanReturnValue will be returned.

In any other case (like the value cannot be interpreted), false is returned, so it's a good idea to set the converter's property in a way that the return is only true if you need it.

ItemCountToOverflowConverter Creates a human-readable text indicating how many items are available. The value will be interpreted as the total item count and the parameter as overflow threshold (defaults to 99).
If there are more items than the overflow, the overflow value with a + sign will be returned (e.g. 99+). If not, the value itself will be returned. If everything fails, null is returned.
NullToBoolConverter Null or an empty string value get converted to true, and everything else to false.
NullToInvertedBoolConverter Null or an empty string value get converted to false, and everything else to true.
PathToImageSourceValueConverter Reads the path provided as parameter and creates an image source from it.

Usage

<Shortly describe how to use the activity ...>