Effect.ResolveId Property

Definition

Namespace:

Xamarin.Forms

Assembly:

Xamarin.Forms.Core.dll

Gets the ID that is used to resolve this effect at runtime.

public string ResolveId { get; }

member this.ResolveId : string

Property Value

System.String

The ID that is used to resolve this effect at runtime.

Remarks

Developers must supply a name to ExportEffectAttribute that is unique over the scope of the name that they supply to ResolutionGroupNameAttribute. The Resolve(String) method takes a string that is the concatenation of name (the resolution group name), '.', and the unique name that was supplied to ExportEffectAttribute, and returns the specified effect.

For example, with the declarations:

[assembly: ResolutionGroupName ("com.YourCompany")]
[assembly: ExportEffect (typeof (ShadowEffect), "ShadowEffect")]

Then the code below will add the effect to a button:

        [var button = new Button { Text = "I have a shadow" };
button.Effects.Add (Effect.Resolve ("com.YourCompany.ShadowEffect"));

This property returns the string that developers pass to Resolve(String) to get the effect at runtime.