Clases y métodos parciales (Guía de programación de C#)Partial Classes and Methods (C# Programming Guide)

Es posible dividir la definición de una clase o un struct, una interfaz o un método en dos o más archivos de código fuente.It is possible to split the definition of a class or a struct, an interface or a method over two or more source files. Cada archivo de código fuente contiene una sección de la definición de tipo o método, y todos los elementos se combinan cuando se compila la aplicación.Each source file contains a section of the type or method definition, and all parts are combined when the application is compiled.

Clases parcialesPartial Classes

Es recomendable dividir una definición de clase en varias situaciones:There are several situations when splitting a class definition is desirable:

  • Cuando se trabaja con proyectos grandes, el hecho de repartir una clase entre archivos independientes permite que varios programadores trabajen en ella al mismo tiempo.When working on large projects, spreading a class over separate files enables multiple programmers to work on it at the same time.

  • Cuando se trabaja con código fuente generado automáticamente, se puede agregar código a la clase sin tener que volver a crear el archivo de código fuente.When working with automatically generated source, code can be added to the class without having to recreate the source file. Visual Studio usa este enfoque al crear formularios Windows Forms, código de contenedor de servicio Web, etc.Visual Studio uses this approach when it creates Windows Forms, Web service wrapper code, and so on. Puede crear código que use estas clases sin necesidad de modificar el archivo creado por Visual Studio.You can create code that uses these classes without having to modify the file created by Visual Studio.

  • Para dividir una definición de clase, use el modificador de palabra clave partial, como se muestra aquí:To split a class definition, use the partial keyword modifier, as shown here:

public partial class Employee
{
    public void DoWork()
    {
    }
}

public partial class Employee
{
    public void GoToLunch()
    {
    }
}

La palabra clave partial indica que se pueden definir en el espacio de nombres otros elementos de la clase, la estructura o la interfaz.The partial keyword indicates that other parts of the class, struct, or interface can be defined in the namespace. Todos los elementos deben usar la palabra clave partial.All the parts must use the partial keyword. Todos los elementos deben estar disponibles en tiempo de compilación para formar el tipo final.All the parts must be available at compile time to form the final type. Todos los elementos deben tener la misma accesibilidad, como public, private, etc.All the parts must have the same accessibility, such as public, private, and so on.

Si algún elemento se declara abstracto, todo el tipo se considera abstracto.If any part is declared abstract, then the whole type is considered abstract. Si algún elemento se declara sellado, todo el tipo se considera sellado.If any part is declared sealed, then the whole type is considered sealed. Si algún elemento declara un tipo base, todo el tipo hereda esa clase.If any part declares a base type, then the whole type inherits that class.

Todos los elementos que especifiquen una clase base deben coincidir, pero los elementos que omitan una clase base heredan igualmente el tipo base.All the parts that specify a base class must agree, but parts that omit a base class still inherit the base type. Los elementos pueden especificar diferentes interfaces base, y el tipo final implementa todas las interfaces enumeradas por todas las declaraciones parciales.Parts can specify different base interfaces, and the final type implements all the interfaces listed by all the partial declarations. Todas las clases, structs o miembros de interfaz declarados en una definición parcial están disponibles para todos los demás elementos.Any class, struct, or interface members declared in a partial definition are available to all the other parts. El tipo final es la combinación de todos los elementos en tiempo de compilación.The final type is the combination of all the parts at compile time.

Nota

El modificador partial no está disponible en declaraciones de delegado o enumeración.The partial modifier is not available on delegate or enumeration declarations.

En el ejemplo siguiente se muestra que los tipos anidados pueden ser parciales, incluso si el tipo en el que están anidados no es parcial.The following example shows that nested types can be partial, even if the type they are nested within is not partial itself.

class Container
{
    partial class Nested
    {
        void Test() { }
    }
    partial class Nested
    {
        void Test2() { }
    }
}

En tiempo de compilación, se combinan los atributos de definiciones de tipo parcial.At compile time, attributes of partial-type definitions are merged. Por ejemplo, consideremos las siguientes declaraciones:For example, consider the following declarations:

[SerializableAttribute]
partial class Moon { }

[ObsoleteAttribute]
partial class Moon { }

Son equivalentes a las declaraciones siguientes:They are equivalent to the following declarations:

[SerializableAttribute]
[ObsoleteAttribute]
class Moon { }

A continuación se indican los elementos que se combinan de todas las definiciones de tipo parcial:The following are merged from all the partial-type definitions:

  • comentarios XMLXML comments

  • interfacesinterfaces

  • atributos de parámetro de tipo genéricogeneric-type parameter attributes

  • class (atributos)class attributes

  • miembrosmembers

Por ejemplo, consideremos las siguientes declaraciones:For example, consider the following declarations:

partial class Earth : Planet, IRotate { }
partial class Earth : IRevolve { }

Son equivalentes a las declaraciones siguientes:They are equivalent to the following declarations:

class Earth : Planet, IRotate, IRevolve { }

RestriccionesRestrictions

Debe seguir varias reglas al trabajar con definiciones de clase parcial:There are several rules to follow when you are working with partial class definitions:

  • Todas las definiciones de tipo parcial que van a formar parte del mismo tipo deben modificarse con partial.All partial-type definitions meant to be parts of the same type must be modified with partial. Por ejemplo, las declaraciones de clase siguientes generan un error:For example, the following class declarations generate an error:

    public partial class A { }
    //public class A { }  // Error, must also be marked partial
    
  • El modificador partial solo puede aparecer inmediatamente antes de las palabras clave class, struct o interface.The partial modifier can only appear immediately before the keywords class, struct, or interface.

  • Se permiten tipos parciales anidados en definiciones de tipo parcial, como se muestra en el ejemplo siguiente:Nested partial types are allowed in partial-type definitions as illustrated in the following example:

    partial class ClassWithNestedClass
    {
        partial class NestedClass { }
    }
    
    partial class ClassWithNestedClass
    {
        partial class NestedClass { }
    }
    
  • Todas las definiciones de tipo parcial que van a formar parte del mismo tipo deben definirse en el mismo ensamblado y en el mismo módulo (archivo .exe o .dll).All partial-type definitions meant to be parts of the same type must be defined in the same assembly and the same module (.exe or .dll file). Las definiciones parciales no pueden abarcar varios módulos.Partial definitions cannot span multiple modules.

  • El nombre de clase y los parámetros de tipo genérico deben coincidir en todas las definiciones de tipo parcial.The class name and generic-type parameters must match on all partial-type definitions. Los tipos genéricos pueden ser parciales.Generic types can be partial. Cada declaración parcial debe usar los mismos nombres de parámetro en el mismo orden.Each partial declaration must use the same parameter names in the same order.

  • Las siguientes palabras clave son opcionales en una definición de tipo parcial, pero si están presentes la definición, no pueden entrar en conflicto con las palabras clave especificadas en otra definición parcial para el mismo tipo:The following keywords on a partial-type definition are optional, but if present on one partial-type definition, cannot conflict with the keywords specified on another partial definition for the same type:

Ejemplo 1Example 1

DescriptionDescription

En el ejemplo siguiente, los campos y el constructor de la clase, CoOrds, se declaran en una definición de clase parcial y el miembro PrintCoOrds se declara en otra definición de clase parcial.In the following example, the fields and the constructor of the class, CoOrds, are declared in one partial class definition, and the member, PrintCoOrds, is declared in another partial class definition.

CódigoCode

public partial class CoOrds
{
    private int x;
    private int y;

    public CoOrds(int x, int y)
    {
        this.x = x;
        this.y = y;
    }
}

public partial class CoOrds
{
    public void PrintCoOrds()
    {
        Console.WriteLine("CoOrds: {0},{1}", x, y);
    }

}

class TestCoOrds
{
    static void Main()
    {
        CoOrds myCoOrds = new CoOrds(10, 15);
        myCoOrds.PrintCoOrds();

        // Keep the console window open in debug mode.
        Console.WriteLine("Press any key to exit.");
        Console.ReadKey();
    }
}
// Output: CoOrds: 10,15

Ejemplo 2Example 2

DescriptionDescription

En el ejemplo siguiente se muestra que también se pueden desarrollar structs e interfaces parciales.The following example shows that you can also develop partial structs and interfaces.

CódigoCode

partial interface ITest
{
    void Interface_Test();
}

partial interface ITest
{
    void Interface_Test2();
}

partial struct S1
{
    void Struct_Test() { }
}

partial struct S1
{
    void Struct_Test2() { }
}

Métodos PartialPartial Methods

Una clase o struct parcial puede contener un método parcial.A partial class or struct may contain a partial method. Un elemento de la clase contiene la firma del método.One part of the class contains the signature of the method. Se puede definir una implementación opcional en el mismo elemento o en otro.An optional implementation may be defined in the same part or another part. Si no se proporciona la implementación, el método y todas las llamadas al método se quitan en tiempo de compilación.If the implementation is not supplied, then the method and all calls to the method are removed at compile time.

Los métodos parciales permiten que el implementador de un elemento de una clase defina un método, similar a un evento.Partial methods enable the implementer of one part of a class to define a method, similar to an event. El implementador del otro elemento de la clase puede decidir si quiere implementar el método o no.The implementer of the other part of the class can decide whether to implement the method or not. Si el método no se implementa, el compilador quita la firma del método y todas las llamadas al método.If the method is not implemented, then the compiler removes the method signature and all calls to the method. Las llamadas al método, incluidos los resultados que se producirían por la evaluación de los argumentos de las llamadas, no tienen efecto en tiempo de ejecución.The calls to the method, including any results that would occur from evaluation of arguments in the calls, have no effect at run time. Por lo tanto, el código de la clase parcial puede usar libremente un método parcial, incluso si no se proporciona la implementación.Therefore, any code in the partial class can freely use a partial method, even if the implementation is not supplied. No se producirá ningún error en tiempo de compilación o en tiempo de ejecución si se llama al método pero no se implementa.No compile-time or run-time errors will result if the method is called but not implemented.

Los métodos parciales son especialmente útiles para personalizar el código generado.Partial methods are especially useful as a way to customize generated code. Permiten reservar un nombre y firma de método de modo que el código generado pueda llamar al método, pero el desarrollador decide si se implementa el método.They allow for a method name and signature to be reserved, so that generated code can call the method but the developer can decide whether to implement the method. De manera muy similar a como hacen las clases parciales, los métodos parciales permiten que el código creado por un generador de código y el código creado por un desarrollador humano funcionen juntos sin costos en tiempo de ejecución.Much like partial classes, partial methods enable code created by a code generator and code created by a human developer to work together without run-time costs.

Una declaración de método parcial consta de dos elementos: la definición y la implementación.A partial method declaration consists of two parts: the definition, and the implementation. Pueden encontrarse en elementos independientes de una clase parcial o en el mismo elemento.These may be in separate parts of a partial class, or in the same part. Si no hay ninguna declaración de implementación, el compilador optimiza tanto la declaración de definición como todas las llamadas al método.If there is no implementation declaration, then the compiler optimizes away both the defining declaration and all calls to the method.

// Definition in file1.cs  
partial void onNameChanged();  

// Implementation in file2.cs  
partial void onNameChanged()  
{  
  // method body  
}  
  • Las declaraciones de método parcial deben comenzar con la palabra clave contextual partial y el método debe devolver void.Partial method declarations must begin with the contextual keyword partial and the method must return void.

  • Los métodos parciales pueden tener parámetros in o ref, pero no parámetros out.Partial methods can have in or ref but not out parameters.

  • Los métodos parciales son implícitamente private y, por tanto, no pueden ser virtual.Partial methods are implicitly private, and therefore they cannot be virtual.

  • Los métodos parciales no pueden ser extern, ya que la presencia del cuerpo determina si son de definición o de implementación.Partial methods cannot be extern, because the presence of the body determines whether they are defining or implementing.

  • Los métodos parciales pueden tener modificadores static y unsafe.Partial methods can have static and unsafe modifiers.

  • Los métodos parciales pueden ser genéricos.Partial methods can be generic. Las restricciones se colocan en la declaración de método parcial de definición y opcionalmente pueden repetirse en el de implementación.Constraints are put on the defining partial method declaration, and may optionally be repeated on the implementing one. Los nombres del parámetro y del parámetro de tipo no tienen que ser iguales en la declaración de implementación y en la declaración de definición.Parameter and type parameter names do not have to be the same in the implementing declaration as in the defining one.

  • Puede crear un delegado para un método parcial que se ha definido e implementado, pero no para un método parcial que solo se ha definido.You can make a delegate to a partial method that has been defined and implemented, but not to a partial method that has only been defined.

Especificación del lenguaje C#C# Language Specification

Para obtener más información, consulte la Especificación del lenguaje C#.For more information, see the C# Language Specification. La especificación del lenguaje es la fuente definitiva de la sintaxis y el uso de C#.The language specification is the definitive source for C# syntax and usage.

Vea tambiénSee Also

Guía de programación de C#C# Programming Guide
ClasesClasses
StructsStructs
InterfacesInterfaces
partial (Tipos)partial (Type)