Skip to content

Add IEffectControlProvider docs #20872

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 28, 2024
Merged

Add IEffectControlProvider docs #20872

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/Controls/src/Core/Element/Element.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -928,6 +928,10 @@ void SetHandler(IElementHandler newHandler)
}
}

/// <summary>
/// Registers the specified <paramref name="effect"/> to this element.
/// </summary>
/// <param name="effect">The effect to be registered.</param>
void IEffectControlProvider.RegisterEffect(Effect effect)
{
if (effect is RoutingEffect re && re.Inner != null)
Expand Down
7 changes: 7 additions & 0 deletions src/Controls/src/Core/IEffectControlProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,15 @@
#nullable disable
namespace Microsoft.Maui.Controls
{
/// <summary>
/// Provides the functionality to register an <see cref="Effect"/> to an element.
/// </summary>
public interface IEffectControlProvider
{
/// <summary>
/// Registers the specified <paramref name="effect"/> to an element.
/// </summary>
/// <param name="effect">The effect to be registered.</param>
void RegisterEffect(Effect effect);
}
}