public interface ITypeNameData

assembly RefDocGen
namespace RefDocGen.CodeElements.Types.Abstract.TypeName
Implements:  ITypeNameBaseData
Represents name-related data of any type, including its name, namespace, and generic parameters (if present).
Doesn't include any type member data (such as fields, methods, etc.)
Note that this interface can represent also 'void', even though it's technically not a type.

Properties

public ITypeNameData DeclaringType { get; } #
The type that contains the declaration of this type.
null if the type is not nested.
public string FullName { get; } #
Inherited from ITypeNameBaseData
Full name of the type, including its namespace.
Note: For generic types, it's doesn't include any info about the generic types.
Examples:
  • for string, it returns "System.String"
  • for List<string>, it returns "System.Collections.Generic.List"
public bool HasTypeParameters { get; } #
Inherited from ITypeNameBaseData
Checks whether the type has any type parameters.
public string Id { get; } #
Inherited from ITypeNameBaseData
Identifier of the type. Consists of the type name and generic parameters (if present).
The format is described here: https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/language-specification/documentation-comments#d42-id-string-format
public bool IsArray { get; } #
Checks whether the type represents an array.
public bool IsGenericParameter { get; } #
Checks whether the type is a generic type parameter.
public bool IsPointer { get; } #
Checks whether the type is a pointer.
public bool IsVoid { get; } #
Checks whether the type represents void.
public string Namespace { get; } #
Inherited from ITypeNameBaseData
Gets the namespace of the type.
Returns empty string, if the current instance represents a generic type parameter or if the type doesn't have any corresponding namespace.
public string ShortName { get; } #
Inherited from ITypeNameBaseData
Short name of the type; doesn't include its namespace.
Note: For generic types, it's doesn't include any info about the generic types.
Examples:
  • for string, it returns "String"
  • for List<string>, it returns "List"
public string TypeDeclarationId { get; } #
Id of the type in the type declaration format (i.e. the same format as RefDocGen.CodeElements.Types.Concrete.TypeDeclaration.Id).
public Type TypeObject { get; } #
Inherited from ITypeNameBaseData
Type object representing the type.
public IReadOnlyList<ITypeNameData> TypeParameters { get; } #
Get all type parameters of the type (both generic and non-generic). If the type doesn't have any parameters, an empty collection is returned.