<Type Name="PreferEventsOverMethodsRule" FullName="Gendarme.Rules.Design.PreferEventsOverMethodsRule">
  <TypeSignature Language="C#" Value="public class PreferEventsOverMethodsRule : Gendarme.Framework.Rule, Gendarme.Framework.IMethodRule" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit PreferEventsOverMethodsRule extends Gendarme.Framework.Rule implements class Gendarme.Framework.IMethodRule, class Gendarme.Framework.IRule" />
  <AssemblyInfo>
    <AssemblyName>Gendarme.Rules.Design</AssemblyName>
    <AssemblyVersion>2.11.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>Gendarme.Framework.Rule</BaseTypeName>
  </Base>
  <Interfaces>
    <Interface>
      <InterfaceName>Gendarme.Framework.IMethodRule</InterfaceName>
    </Interface>
  </Interfaces>
  <Attributes>
    <Attribute>
      <AttributeName>Gendarme.Framework.FxCopCompatibility("Microsoft.Design", "CA1030:UseEventsWhereAppropriate")</AttributeName>
    </Attribute>
    <Attribute>
      <AttributeName>Gendarme.Framework.Problem("This method's name suggests that it could be replaced by an event.")</AttributeName>
    </Attribute>
    <Attribute>
      <AttributeName>Gendarme.Framework.Solution("Replace the method(s) by events or rename the method to something less confusing.")</AttributeName>
    </Attribute>
  </Attributes>
  <Docs>
    <summary>
            This rule checks for method names that suggest they are providing similar
            functionality to .NET events. When possible the method(s) should be replaced
            with a real event. If the methods are not using or providing
            event-like features then they should be renamed since such names can confuse consumers
            about what the method is really doing.
            </summary>
    <remarks>To be added.</remarks>
    <example>
            Bad example:
            <code>
            public delegate void MouseUpCallback (int x, int y, MouseButtons buttons);
            public class MouseController {
            	private MouseUpCallback mouse_up_callback;
            	public void RaiseMouseUp (Message msg)
            	{
            		if (mouse_up_callback != null) {
            			mouse_up_callback (msg.X, msg.Y, msg.Buttons);
            		}
            	}
            	public void ProcessMessage (Message msg)
            	{
            		switch (msg.Id) {
            		case MessageId.MouseUp: {
            			RaiseMouseUp (msg);
            			break;
            		}
            		// ... more ...
            		default:
            			break;
            		}
            	}
            }
            </code></example>
    <example>
            Good example:
            <code>
            public class MouseController {
            	public event EventHandler&lt;MessageEvent&gt; MouseUp;
            	public void ProcessMessage (Message msg)
            	{
            		switch (msg.Id) {
            		case MessageId.MouseUp: {
            			EventHandler&lt;MessageEvent&gt; handler = MouseUp;
            			if (handler != null) {
            				handler (new MessageEvent (msg));
            			}
            			break;
            		}
            		// ... more ...
            		default:
            			break;
            		}
            	}
            }
            </code></example>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public PreferEventsOverMethodsRule ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.11.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="CheckMethod">
      <MemberSignature Language="C#" Value="public Gendarme.Framework.RuleResult CheckMethod (Mono.Cecil.MethodDefinition method);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance valuetype Gendarme.Framework.RuleResult CheckMethod(class Mono.Cecil.MethodDefinition method) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.11.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Gendarme.Framework.RuleResult</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="method" Type="Mono.Cecil.MethodDefinition" />
      </Parameters>
      <Docs>
        <param name="method">To be added.</param>
        <summary>To be added.</summary>
        <returns>To be added.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>
