EnumType

Description

sealed class Tinman.Core.Config.EnumType

Derived from: ConfigType ^abstract

Config property type: enumeration type.

This type should not be used as the target for type casting expressions, see ConfigType.IsEnum for details.

Public / Constructors

Builder

public static method Builder → (2)

name ⁱⁿ : string: [not-empty]
The enum name.
module ⁱⁿ : TinmanModule: [not-null]
The module that owns the new enum type.
returns → EnumTypeBuilder: The builder object.

Returns a builder for creating a new enum type.

Of

public static method Of → (1)

type ⁱⁿ : ConfigType: The type or null.
returns → EnumType: The result of ConfigType.AsEnumNull or null if type ⁱⁿ is null.

Helper that calls ConfigType.AsEnumNull on the given type ⁱⁿ.

Public / Methods

GetItem

public method GetItem → (1)

index ⁱⁿ : int32: [0..EnumType.ItemCount-1]
Index of enum item.
returns → EnumItem: The enum item.

Returns an enum item.

GetItemOrdinal

public method GetItemOrdinal → (2)

name ⁱⁿ : string: The enum item name.
tag ^opt : bool = false: Use tag name?
returns → int32: Ordinal number of enum item or -1 if name ⁱⁿ is not a valid enum item name.

Returns the ordinal number of the given enum item.

Public / Attributes

ItemCount

public attribute ItemCount → (get)

value : int32: [>0]
The number of enumeration items.

Returns the number of enumeration items.

Items

public attribute Items → (get)

value : EnumItem [ ]: [not-null]
The enum items.

Returns the items of this enumeration.

ShouldHaveDocumentation

public attribute ShouldHaveDocumentation → (get)

value : bool: true if documentation should exist, false if not (e.g. if the enum items are generated by code, having meaningful names).

Should the item of this enumeration be documented?

See also: EnumTypeBuilder.CodeGen