CodeModel.md

March 24, 2024 ยท View on GitHub

This file was auto generated from template : CodeModel.nt

NTypewriter CodeModel

Above diagram was generated from : NTypewriter.CodeModel.flowchart.mmd

IAttribute

Represents a declared attribute on a symbol.

PropertyDescriptionReturns
ArgumentsThe arguments of the attribute.IEnumerable<IAttributeArgument>
AttributeClassThe attribute class.IClass
FullNameThe full original name of the attribute including namespace and containing class names.string
NameThe name of the attribute without Attribute postfix.string

Implements :


IAttributeArgument

Represents attribute argument.

PropertyDescriptionReturns
IsFromConstructorDetermines if arguments is present in the attribute constructorbool
NameThe name of the argument.string
TypeThe type of the argument.IType
ValueThe value of the argumentobject

Implements :


IClass

Represents a class.

PropertyDescriptionReturns
BaseClassThe declared base class of this class, or null. Returns null if the class inherits from System.Object.IClass
ConstructorsAll instance constructors defined in the class.IEnumerable<IMethod>
EventsAll events defined in the class.IEnumerable<IEvent>
FieldsAll fields defined in the class.IEnumerable<IField>
HasBaseClassDetermines if the class has base class other than System.Object.bool
IsSealedDetermines if the class is sealedbool
MethodsAll methods defined in the class.IEnumerable<IMethod>
NestedClassesAll nested classes defined in the class.IEnumerable<IClass>
NestedDelegatesAll nested delegates defined in the class.IEnumerable<IDelegate>
NestedEnumsAll nested enums defined in the class.IEnumerable<IEnum>
NestedInterfacesAll nested interfaces defined in the class.IEnumerable<IInterface>
PropertiesAll properties defined in the class.IEnumerable<IProperty>

Implements : INamedType


ICodeModel

Representation of the code. ICodeModel is the entry point of accessing information about the code.

PropertyDescriptionReturns
ClassesAll classes defined in the codeIEnumerable<IClass>
DelegatesAll delegates defined in the codeIEnumerable<IDelegate>
EnumsAll enums defined in the codeIEnumerable<IEnum>
InterfacesAll interfaces defined in the codeIEnumerable<IInterface>
StructsAll structs defined in the codeIEnumerable<IStruct>

Implements :


IDelegate

Represents a delegate.

PropertyDescriptionReturns
ParametersThe parameters of this delegate. If this delegate has no parameters, returns an empty collection.IEnumerable<IParameter>
ReturnTypeThe return type of the delegate.IType

Implements : INamedType


IDocumentationCommentXml

Represents a documentation XML comment.

PropertyDescriptionReturns
ParamsCollection of the param tag.IEnumerable<IDocumentationCommentXmlParam>
ReturnsThe content of the return tag.string
SummaryThe content of the summary tag.string

Implements :


IDocumentationCommentXmlParam

Represents a documentation XML param tag.

PropertyDescriptionReturns
NameThe value of the name attributestring
ValueThe content of the param tagstring

Implements :


IEnum

Represents an enum.

PropertyDescriptionReturns
UnderlyingTypeGets the underlying typeIType
ValuesAll values defined in the enum.IEnumerable<IEnumValue>

Implements : INamedType


IEnumValue

Represents a named constant which is a member of an enum.

PropertyDescriptionReturns
AttributesAll attributes declared on the enum value.IEnumerable<IAttribute>
NameThe name of the enum memberstring
ValueThe value of the enum memberobject

Implements :


IEvent

Represents an event.

PropertyDescriptionReturns
IsSealedDetermines if the event is sealedbool
TypeThe type of the event.IType

Implements : ISymbolBase


IField

Represents a field.

PropertyDescriptionReturns
ConstantValueConstant value assigned to this fieldobject
HasConstantValueReturns false if the field wasn't declared as "const", or constant value was omitted or erroneous. True otherwise.bool
IsConstDetermines if the field was declared as "const".bool
IsReadOnlyDetermines if the field was declared as "readonly".bool
TypeThe type of the field.IType

Implements : ISymbolBase


IInterface

Represents a interface.

PropertyDescriptionReturns
EventsAll events defined in the interface.IEnumerable<IEvent>
MethodsAll methods defined in the interface.IEnumerable<IMethod>
PropertiesAll properties defined in the interface.IEnumerable<IProperty>

Implements : INamedType


ILocation

A program location in source code.

PropertyDescriptionReturns
EndLinePositionGets the last line numberint
IsInSourceReturns true if the location represents a specific location in a source code file.bool
PathPath, or null if the span represents an invalid value.string
StartLinePositionGets the first line numberint

Implements :


IMethod

Represents a method.

PropertyDescriptionReturns
IsAsyncDetermines if the method is an async methodbool
IsGenericDetermines if the method is generic (it has any type parameters)bool
IsInitOnlyReturns true for 'init' set accessors, and false otherwise.bool
IsOverrideDetermines if the method is overridebool
IsSealedDetermines if the method is sealedbool
ParametersAll parameters of the method.IEnumerable<IParameter>
ReturnTypeThe return type of the method.IType
TypeParametersThe type parameters of the method. If the method is not generic, returns an empty collection.IEnumerable<ITypeParameter>

Implements : ISymbolBase


INamedType

Represents a type other than an array, a pointer, a type parameter.

PropertyDescriptionReturns
IsNestedDetermines if the type is declared inside other typebool
TypeParametersThe type parameters of the type. If the type is not generic, returns an empty collection.IEnumerable<ITypeParameter>

Implements : IType


IParameter

Represents a method parameter.

PropertyDescriptionReturns
DefaultValueThe default value of the parameterobject
HasDefaultValueDetermines if the parameter has a default value to be passed when no value is provided as an argument to a call.bool
TypeThe type of the parameterIType

Implements : ISymbolBase


IProperty

Represents a property.

PropertyDescriptionReturns
GetMethodGetterIMethod
IsIndexerDetermines if the property is really an indexer.bool
IsReadOnlyDetermines if the property is a read-only propertybool
IsSealedDetermines if the property is sealedbool
IsWriteOnlyDetermines if the property is a write-only propertybool
SetMethodSetterIMethod
TypeThe type of the property.IType

Implements : ISymbolBase


IStruct

Represents a struct.

PropertyDescriptionReturns
ConstructorsAll instance constructors defined in the struct.IEnumerable<IMethod>
EventsAll events defined in the struct.IEnumerable<IEvent>
FieldsAll fields defined in the struct.IEnumerable<IField>
MethodsAll methods defined in the struct.IEnumerable<IMethod>
NestedClassesAll nested classes defined in the struct.IEnumerable<IClass>
NestedDelegatesAll nested delegates defined in the struct.IEnumerable<IDelegate>
NestedEnumsAll nested enums defined in the struct.IEnumerable<IEnum>
NestedInterfacesAll nested interfaces defined in the struct.IEnumerable<IInterface>
PropertiesAll properties defined in the struct.IEnumerable<IProperty>

Implements : INamedType


ISymbolBase

Represents a symbol (namespace, class, method, parameter, etc.)

PropertyDescriptionReturns
AttributesAll attributes declared on the symbol.IEnumerable<IAttribute>
BareNameThe prefix of the Name that consists only letters and digits.string
ContainingTypeThe type that contains this symbol.INamedType
DocCommentThe XML documentation for the comment associated with the symbol.IDocumentationCommentXml
FullNameThe Namespace + the name of the symbolstring
IsAbstractDetermines if the symbol is abstractbool
IsArrayDetermines if the symbol is an arraybool
IsErrorTypeDetermines if the symbol represents an error in syntax;bool
IsEventDetermines if the symbol is an eventbool
IsFieldDetermines if the symbol is a fieldbool
IsInternalDetermines if the symbol is internalbool
IsMethodDetermines if the symbol is a methodbool
IsPrivateDetermines if the symbol is privatebool
IsPrivateProtectedDetermines if the symbol is private protectedbool
IsPropertyDetermines if the symbol is a propertybool
IsProtectedDetermines if the symbol is protectedbool
IsProtectedInternalDetermines if the symbol is protected internalbool
IsPublicDetermines if the symbol is publicbool
IsStaticDetermines if the symbol is staticbool
IsTypeParameterDetermines if the symbol is a type parameterbool
IsVirtualDetermines if the symbol is virtualbool
LocationsGets the locations where the symbol was originally defined, either in source or metadata. Some symbols (for example, partial classes) may be defined in more than one location.IEnumerable<ILocation>
NameThe name of the symbolstring
NamespaceThe nearest enclosing namespace for the symbol.string
SourceCodestring

Implements :


IType

Represents a type.

PropertyDescriptionReturns
AllInterfacesThe list of all interfaces of which this type is a declared subtype, excluding this type itself.IEnumerable<IInterface>
ArrayTypeThe type of the elements stored in the array.IType
BaseTypeThe declared base type of this type, or null. Returns null if the class inherits from System.Object or if the type is a value type.IType
InterfacesThe set of interfaces that this type directly implements. This set does not include interfaces that are base interfaces of directly implemented interfaces.IEnumerable<IInterface>
IsAnonymousTypeDetermines if the type is anonymousbool
IsCollectionDetermines if the type is a collectionbool
IsDelegateDetermines if the type is a delegatebool
IsDynamicDetermines if the type is a dynamicbool
IsEnumDetermines if the type is an enumbool
IsEnumerableDetermines if the type is enumerablebool
IsGenericDetermines if the type is genericbool
IsInterfaceDetermines if the type is an interfacebool
IsNullableDetermines if the type is nullablebool
IsPrimitiveDetermines if the type is primitivebool
IsRecordDetermines if the type is a recordbool
IsReferenceTypeDetermines if the type is a reference typebool
IsTupleDetermines if the type is a tuplebool
IsValueTypeDetermines if the type is a value typebool
TypeArgumentsThe type arguments that have been substituted for the type parametersIEnumerable<IType>

Implements : ISymbolBase


ITypedConstant

Represents a typed constant.

PropertyDescriptionReturns
TypeThe type of the constant.IType
ValueThe value for a non-array constant.object

Implements :


ITypeParameter

Represents a generic type parameter

PropertyDescriptionReturns

Implements :


ITypeReferencedByMember

PropertyDescriptionReturns
ParentISymbolBase

Implements : IType