Last modified on 26 January 2021, at 11:10

EvalExpression

Revision as of 11:10, 26 January 2021 by LGE (Talk | contribs)

EvalExpression
220px
imagecaption
Name EvalExpression
Namespace "using:UBIK.WinX.Controls" in UBIK.UWP
"clr-namespace:UBIK.CPL.Controls;assembly=UBIK.CPL" in UBIK.Xamarin
Purpose Evaluate a C# expression in XAML
Version 3.2+ in UBIK.UWP 1.0+ in UBIK.Xamarin


Concept

The EvalExpression control allows to evaluate a C# expression from within XAML markup. The Expression has to be a single-line, valid C# expression ("Lambda") and has to return a single value; expressions can also reference names of subordinate EvalExpressionParameter items.

Parameters

EvalExpressionParameters can be added as child objects to an EvalExpression control. Each parameter object needs a unique Name and a Value, where the latter can be either a constant or dynamic value supplied through a binding.

Examples

IC Hint square.pngWhen writing expressions in XAML code, you have to avoid (escape) special characters. There are useful online tools for this.
IC Hint square.pngWhen writing expressions, it's always better (even necessary in some cases) to write them in their full forms. For example, while Bool_A || Bool_B is a valid expression, you should still write Bool_A==true || Bool_B==true instead.

Evaluation without parameters

The following example shows how to evaluate a simple expression without using any parameters and then use the result for visibility binding.

UWP

<StackPanel xmlns:ctrls="using:UBIK.WinX.Controls">
    <ctrls:EvalExpression
       x:Name="Evaluator"
       Context="{Binding}"
       Expression="Context.Values[&quot;LK_OFFLINE&quot;]!=null || Context.Values[&quot;GUIDREF&quot;]!=null" />
    <TextBlock
       Foreground="White"
       Visibility="{Binding ElementName=Evaluator, Path=Result, Converter={StaticResource BoolToVisConverter}}" />
</StackPanel>

The TextBlock should be visible as long as at least one of the context object's two named properties has a value.

Xamarin

<StackLayout xmlns:ctrls="clr-namespace:UBIK.CPL.Controls;assembly=UBIK.CPL">
    <ctrls:EvalExpression
       x:Name="Evaluator"
       Context="{Binding}"
       Expression="Context.Values[&quot;LK_EXAMPLE&quot;]!=null || Context.Values[&quot;GUIDREF&quot;]!=null" />
    <Label
       TextColor="#00000"
       IsVisible="{Binding Path=Result, Source={x:Reference Evaluator}, Converter={StaticResource NullToBoolConverter}}" />
</StackLayout>

The Label should be visible as long as at least one of the context object's two named properties has a value.

Simple calculation

UWP

The following example shows how to use an expression with two parameters (Param0 and Param1). The evaluated Result is then bound to a TextBlock for output in the UI.

<StackPanel xmlns:ctrls="using:UBIK.WinX.Controls">
    <TextBox x:Name="Expression" Width="200" />
    <TextBox x:Name="Param0" Width="200" />
    <TextBox x:Name="Param1" Width="200" />
    <ctrls:EvalExpression x:Name="Evaluator" Expression="{Binding ElementName=Expression, Path=Text}" Context="{Binding}">
        <ctrls:EvalExpressionParameter Name="P0" Value="{Binding ElementName=Param0, Path=Text, Converter={StaticResource ToType}, ConverterParameter='System.Int32'}" />
        <ctrls:EvalExpressionParameter Name="P1" Value="{Binding ElementName=Param1, Path=Text, Converter={StaticResource ToType}, ConverterParameter='System.Int32'}" />
    </ctrls:EvalExpression>
    <TextBlock Foreground="White" Text="{Binding ElementName=Evaluator, Path=Result}" />
</StackPanel>

Lets assume that the Textbox Param0 contains a text of 42 and Param1 contains a text of 43. If Expression now contains (P0 + P1) *2 then the result would display 170.

Xamarin

The following example shows how to use an expression with two parameters (Param0 and Param1). The evaluated Result is then bound to a Label for output in the UI.

<StackLayout xmlns:ctrls="clr-namespace:UBIK.CPL.Controls;assembly=UBIK.CPL">
    <Editor x:Name="Expression"/>
    <Editor x:Name="P0" WidthRequest="32"/>
    <Editor x:Name="P1" WidthRequest="43"/>
    <ctrls:EvalExpression x:Name="Evaluator" Expression="{Binding Path=Text, Source={x:Reference Expression}}" Context="{Binding}">
        <ctrls:EvalExpressionParameter Name="P0" Value="{Binding Path=WidthRequest, Source={x:Reference P0}}" />
        <ctrls:EvalExpressionParameter Name="P1" Value="{Binding Path=WidthRequest, Source={x:Reference P1}}" />
    </ctrls:EvalExpression>
    <Label Text="{Binding Path=Result, Source={x:Reference Evaluator}}" />
</StackLayout>

Since Textbox P0 has a width of 32 and P1 has a width of 43. If Expression now contains (P0 + P1) then the result would display 75.

Setting a calculated property value

The following example shows how to create a button that adds and stores +5 to the value of a a numeric property named MP_EXAMPLE, every time it is pressed:

UWP

<Grid xmlns:ctrls="using:UBIK.WinX.Controls">
    <ctrls:EvalExpression x:Name="Evaluator" Expression="&quot;MP_EXAMPLE|&quot; + (P0 + 5)" Context="{Binding}">
        <ctrls:EvalExpressionParameter Name="P0" Value="{Binding Values[MP_EXAMPLE]}" />
    </ctrls:EvalExpression>
    <Button
       Content="Tap for 5 more"
       Command="{Binding SetPropertyValueAndValidateCommand}"
       CommandParameter="{Binding ElementName=Evaluator, Path=Result}"/>
</Grid>

Xamarin

<Grid xmlns:ctrls="clr-namespace:UBIK.CPL.Controls;assembly=UBIK.CPL">
    <ctrls:EvalExpression x:Name="Evaluator" Expression="&quot;MP_EXAMPLE|&quot; + (P0 + 5)" Context="{Binding}">
        <ctrls:EvalExpressionParameter Name="P0" Value="{Binding Values[MP_EXAMPLE]}" />
    </ctrls:EvalExpression>
    <Button
       Text="Tap to add 5 more"
       Command="{Binding SetPropertyValueAndValidateCommand}"
       CommandParameter="{Binding Path=Result, Source={x:Reference Evaluator}}"/>
</Grid>

Conditional statement

UWP

If / Or statements can be evaluated using the C# syntax P0==true ? P1 : P2. In this case, if the result of the P0 expression is True, P1 will be effected. Otherwise, P2 will be.

<Grid xmlns:ctrls="using:UBIK.WinX.Controls">
    <ctrls:EvalExpression x:Name="InitialiseParameterWhenNull" Expression="(P0==null) ? P1 : P2" Context="{Binding}">
        <ctrls:EvalExpressionParameter Name="P0" Value="{Binding StoredProfileParameters[WPType1]}" />
        <ctrls:EvalExpressionParameter Name="P1" Value="WPType1=1" />
        <ctrls:EvalExpressionParameter Name="P2" Value="{Binding ElementName=InitialiseParameter, Path=Result}" />
    </ctrls:EvalExpression>
</Grid>

Xamarin

If / Or statements can also be evaluated using various C# syntax. In this case, if the result of the P0 expression is true P00 will be used, if P1 is true P10 will be used.

<Grid xmlns:ctrls="clr-namespace:UBIK.CPL.Controls;assembly=UBIK.CPL">
    <controls:EvalExpression x:Name="Evaluator" Expression="P0 == true ? P00 : (P1 == true ? P10)" Context="{Binding}">
        <controls:EvalExpressionParameter Name="P0" Value="{Binding Values[MP_STATUS], Converter={StaticResource EqualityToBool}, ConverterParameter=0}" />
        <controls:EvalExpressionParameter Name="P00" Value="State1" />
        <controls:EvalExpressionParameter Name="P1" Value="{Binding Values[MP_STATUS], Converter={StaticResource EqualityToBool}, ConverterParameter=10}" />
        <controls:EvalExpressionParameter Name="P10" Value="State2" />
    </controls:EvalExpression>         
    <Label Text="{Binding Path=Result, Source={x:Reference Evaluator}}" />
</Grid>

See also