Nota:
El acceso a esta página requiere autorización. Puede intentar iniciar sesión o cambiar directorios.
El acceso a esta página requiere autorización. Puede intentar cambiar los directorios.
Declara una enumeración y define los valores de sus miembros.
Sintaxis
[ <attributelist> ] [ accessmodifier ] [ Shadows ]
Enum enumerationname [ As datatype ]
memberlist
End Enum
Partes
attributelistOpcional. Lista de atributos que se aplican a esta enumeración. Debe incluir la lista de atributos entre corchetes angulares ("
<" y ">").El FlagsAttribute atributo indica que el valor de una instancia de la enumeración puede incluir varios miembros de enumeración y que cada miembro representa un campo de bits en el valor de enumeración.
accessmodifierOpcional. Especifica qué código puede tener acceso a esta enumeración. Puede ser uno de los siguientes:
ShadowsOpcional. Especifica que esta enumeración vuelve a declarar y oculta un elemento de programación con nombre idéntico, o un conjunto de elementos sobrecargados, en una clase base. Solo puede especificar Shadows en la propia enumeración, no en ninguno de sus miembros.
enumerationnameObligatorio. Nombre de la enumeración. Para obtener información sobre los nombres válidos, vea Nombres de elementos declarados.
datatypeOpcional. Tipo de datos de la enumeración y todos sus miembros.
memberlistObligatorio. Lista de constantes de miembro que se declaran en esta instrucción. Varios miembros aparecen en líneas de código fuente individuales.
Cada
membertiene la sintaxis y las partes siguientes:[<attribute list>] membername [ = initializer ]Parte Descripción membernameObligatorio. Nombre de este miembro. initializerOpcional. Expresión que se evalúa en tiempo de compilación y se asigna a este miembro. EndEnumFinaliza el
Enumbloque.
Observaciones
Si tiene un conjunto de valores sin cambiar que están relacionados lógicamente entre sí, puede definirlos juntos en una enumeración. Esto proporciona nombres significativos para la enumeración y sus miembros, que son más fáciles de recordar que sus valores. A continuación, puede usar los miembros de enumeración en muchos lugares del código.
Entre las ventajas de usar enumeraciones se incluyen las siguientes:
Reduce los errores causados por la transposición o escritura incorrecta de números.
Facilita el cambio de valores en el futuro.
Facilita la lectura del código, lo que significa que es menos probable que se introduzcan errores.
Garantiza la compatibilidad futura. Si usa enumeraciones, es menos probable que se produzca un error en el código si en el futuro alguien cambia los valores correspondientes a los nombres de miembro.
Una enumeración tiene un nombre, un tipo de datos subyacente y un conjunto de miembros. Cada miembro representa una constante.
Una enumeración declarada en el nivel de clase, estructura, módulo o interfaz, fuera de cualquier procedimiento, es una enumeración de miembros. Es un miembro de la clase, estructura, módulo o interfaz que lo declara.
Se puede acceder a las enumeraciones de miembros desde cualquier lugar dentro de su clase, estructura, módulo o interfaz. El código fuera de una clase, estructura o módulo debe calificar el nombre de una enumeración de miembro con el nombre de esa clase, estructura o módulo. Puede evitar la necesidad de usar nombres completos agregando una instrucción Imports al archivo de origen.
Una enumeración declarada en el nivel de espacio de nombres, fuera de cualquier clase, estructura, módulo o interfaz, es un miembro del espacio de nombres en el que aparece.
El contexto de declaración de una enumeración debe ser un archivo de origen, un espacio de nombres, una clase, una estructura, un módulo o una interfaz, y no puede ser un procedimiento. Para obtener más información, vea Contextos de declaración y Niveles de acceso predeterminados.
Puede aplicar atributos a una enumeración en su conjunto, pero no a sus miembros individualmente. Un atributo contribuye a la información a los metadatos del ensamblado.
Tipo de datos
La Enum instrucción puede declarar el tipo de datos de una enumeración. Cada miembro toma el tipo de datos de la enumeración. Puede especificar Byte, , , IntegerLong, SByte, ShortUIntegero ULong. UShort
Si no especifica datatype para la enumeración, cada miembro toma el tipo de datos de su initializer. Si especifica y datatypeinitializer, el tipo de datos de initializer debe convertirse en datatype. Si ni está datatypeinitializer presente, el tipo de datos tiene Integercomo valor predeterminado .
Inicialización de miembros
La Enum instrucción puede inicializar el contenido de los miembros seleccionados en memberlist. Se usa initializer para proporcionar una expresión que se va a asignar al miembro.
Si no especifica initializer para un miembro, Visual Basic lo inicializa en cero (si es el primero member en memberlist), o en un valor mayor por uno de los inmediatamente anteriores membera .
La expresión proporcionada en cada initializer uno puede ser cualquier combinación de literales, otras constantes que ya están definidas y miembros de enumeración que ya están definidos, incluido un miembro anterior de esta enumeración. Puede usar operadores aritméticos y lógicos para combinar estos elementos.
No se pueden usar variables ni funciones en initializer. Sin embargo, puede usar palabras clave de conversión como CByte y CShort. También puede usar AscW si lo llama con una constante String o Char argumento, ya que se puede evaluar en tiempo de compilación.
Las enumeraciones no pueden tener valores de punto flotante. Si a un miembro se le asigna un valor de punto flotante y Option Strict se establece en activado, se produce un error del compilador. Si Option Strict está desactivado, el valor se convierte automáticamente en el Enum tipo .
Si el valor de un miembro supera el intervalo permitido para el tipo de datos subyacente, o si inicializa cualquier miembro al valor máximo permitido por el tipo de datos subyacente, el compilador notifica un error.
Modificadores
Enumeraciones de miembros de clase, estructura, módulo e interfaz predeterminadas para el acceso público. Puede ajustar sus niveles de acceso con los modificadores de acceso. Enumeraciones de miembros de espacio de nombres predeterminadas para el acceso de confianza. Puede ajustar sus niveles de acceso a públicos, pero no a privados o protegidos. Para obtener más información, vea Niveles de acceso en Visual Basic.
Todos los miembros de enumeración tienen acceso público y no se pueden usar modificadores de acceso en ellos. Sin embargo, si la enumeración tiene un nivel de acceso más restringido, el nivel de acceso de enumeración especificado tiene prioridad.
De forma predeterminada, todas las enumeraciones son tipos y sus campos son constantes. Por lo tanto, las Sharedpalabras clave , Staticy ReadOnly no se pueden usar al declarar una enumeración o sus miembros.
Asignación de varios valores
Las enumeraciones suelen representar valores mutuamente excluyentes. Al incluir el FlagsAttribute atributo en la Enum declaración, puede asignar varios valores a una instancia de la enumeración. El FlagsAttribute atributo especifica que la enumeración se trata como un campo de bits, es decir, un conjunto de marcas. Se denominan enumeraciones bit a bit .
Al declarar una enumeración mediante el FlagsAttribute atributo , se recomienda usar potencias de 2, es decir, 1, 2, 4, 8, 16, etc., para los valores. También se recomienda que "None" sea el nombre de un miembro cuyo valor sea 0. Para obtener instrucciones adicionales, consulte FlagsAttribute y Enum.
Ejemplo 1
En el ejemplo siguiente se muestra cómo usar la Enum instrucción . Tenga en cuenta que el miembro se conoce como EggSizeEnum.Mediumy no como Medium.
Public Class Egg
Enum EggSizeEnum
Jumbo
ExtraLarge
Large
Medium
Small
End Enum
Public Sub Poach()
Dim size As EggSizeEnum
size = EggSizeEnum.Medium
' Continue processing...
End Sub
End Class
Ejemplo 2
El método del ejemplo siguiente está fuera de la Egg clase . Por lo tanto, EggSizeEnum está completo como Egg.EggSizeEnum.
Public Sub Scramble(ByVal size As Egg.EggSizeEnum)
' Process for the three largest sizes.
' Throw an exception for any other size.
Select Case size
Case Egg.EggSizeEnum.Jumbo
' Process.
Case Egg.EggSizeEnum.ExtraLarge
' Process.
Case Egg.EggSizeEnum.Large
' Process.
Case Else
Throw New ApplicationException("size is invalid: " & size.ToString)
End Select
End Sub
Ejemplo 3
En el ejemplo siguiente se usa la Enum instrucción para definir un conjunto relacionado de valores constantes con nombre. En este caso, los valores son colores que puede elegir para diseñar formularios de entrada de datos para una base de datos.
Public Enum InterfaceColors
MistyRose = &HE1E4FF&
SlateGray = &H908070&
DodgerBlue = &HFF901E&
DeepSkyBlue = &HFFBF00&
SpringGreen = &H7FFF00&
ForestGreen = &H228B22&
Goldenrod = &H20A5DA&
Firebrick = &H2222B2&
End Enum
Ejemplo 4
En el ejemplo siguiente se muestran valores que incluyen números positivos y negativos.
Enum SecurityLevel
IllegalEntry = -1
MinimumSecurity = 0
MaximumSecurity = 1
End Enum
Ejemplo 5
En el ejemplo siguiente, se usa una As cláusula para especificar el datatype de una enumeración.
Public Enum MyEnum As Byte
Zero
One
Two
End Enum
Ejemplo 6
En el ejemplo siguiente se muestra cómo usar una enumeración bit a bit. Se pueden asignar varios valores a una instancia de una enumeración bit a bit. La Enum declaración incluye el FlagsAttribute atributo , que indica que la enumeración se puede tratar como un conjunto de marcas.
' Apply the Flags attribute, which allows an instance
' of the enumeration to have multiple values.
<Flags()> Public Enum FilePermissions As Integer
None = 0
Create = 1
Read = 2
Update = 4
Delete = 8
End Enum
Public Sub ShowBitwiseEnum()
' Declare the non-exclusive enumeration object and
' set it to multiple values.
Dim perm As FilePermissions
perm = FilePermissions.Read Or FilePermissions.Update
' Show the values in the enumeration object.
Console.WriteLine(perm.ToString)
' Output: Read, Update
' Show the total integer value of all values
' in the enumeration object.
Console.WriteLine(CInt(perm))
' Output: 6
' Show whether the enumeration object contains
' the specified flag.
Console.WriteLine(perm.HasFlag(FilePermissions.Update))
' Output: True
End Sub
Ejemplo 7
En el ejemplo siguiente se recorre en iteración una enumeración. Usa el GetNames método para recuperar una matriz de nombres de miembro de la enumeración y GetValues para recuperar una matriz de valores de miembro.
Enum EggSizeEnum
Jumbo
ExtraLarge
Large
Medium
Small
End Enum
Public Sub Iterate()
Dim names = [Enum].GetNames(GetType(EggSizeEnum))
For Each name In names
Console.Write(name & " ")
Next
Console.WriteLine()
' Output: Jumbo ExtraLarge Large Medium Small
Dim values = [Enum].GetValues(GetType(EggSizeEnum))
For Each value In values
Console.Write(value & " ")
Next
Console.WriteLine()
' Output: 0 1 2 3 4
End Sub
Consulte también
Colaborar con nosotros en GitHub
El origen de este contenido se puede encontrar en GitHub, donde también puede crear y revisar problemas y solicitudes de incorporación de cambios. Para más información, consulte nuestra guía para colaboradores.
