public class IndexerTM

assembly RefDocGen
namespace RefDocGen.TemplateProcessors.Shared.TemplateModels.Members
Base type:  object
Implements:  IEquatable<IndexerTM>
Represents the template model for an indexer.

Constructors

public IndexerTM(string Id, GenericTypeLinkTM Type, ParameterTM[] Parameters, bool HasGetter, bool HasSetter, bool IsSetterInitOnly, LanguageSpecificData<string[]> Modifiers, LanguageSpecificData<string[]> GetterModifiers, LanguageSpecificData<string[]> SetterModifiers, AttributeTM[] Attributes, string SummaryDocComment, string RemarksDocComment, string ValueDocComment, string ExampleDocComment, string[] SeeAlsoDocComments, ExceptionTM[] Exceptions, CodeLinkTM InheritedFrom, CodeLinkTM BaseDeclaringType, CodeLinkTM ExplicitInterfaceType, CodeLinkTM[] ImplementedInterfaces) #
Represents the template model for an indexer.
Parameters
string Id
Identifier of the indexer.
GenericTypeLinkTM Type
Type of the indexer.
ParameterTM[] Parameters
Collection of index parameters.
bool HasGetter
Checks if the indexer has getter.
bool HasSetter
Checks if the indexer has setter (returns true for init only setters as well).
bool IsSetterInitOnly
Checks if the property has init only setter.
LanguageSpecificData<string[]> Modifiers
Collection of indexer modifiers (e.g. public, static, etc.)
LanguageSpecificData<string[]> GetterModifiers
Collection of the getter modifiers (possibly empty).
LanguageSpecificData<string[]> SetterModifiers
Collection of the setter modifiers (possibly empty).
AttributeTM[] Attributes
Array of attributes applied to the indexer.
string SummaryDocComment
summary documentation comment for the indexer. null if the doc comment is not provided.
string RemarksDocComment
remarks documentation comment for the indexer. null if the doc comment is not provided.
string ValueDocComment
value documentation comment for the indexer. null if the doc comment is not provided.
string ExampleDocComment
example documentation comment for the indexer. null if the doc comment is not provided.
string[] SeeAlsoDocComments
Collection of seealso documentation comments for the indexer.
ExceptionTM[] Exceptions
A collection of user-documented exceptions (using the exception XML tag) that the indexer might throw.
CodeLinkTM InheritedFrom
If the indexer is inherited, this represents the type from which it originates. null if the indexer is not inherited.
CodeLinkTM BaseDeclaringType
If the indexer overrides another member, this property returns the base type that originally declared the member. null if the indexer doesn't override anything.
CodeLinkTM ExplicitInterfaceType
If the indexer is an explicit implementation, the type of the interface that explicitly declared it is returned. null if the indexer is not an explicit implementation.
CodeLinkTM[] ImplementedInterfaces
Returns the types of the interfaces, whose part of contract this indexer implements.

Properties

public AttributeTM[] Attributes { get; init; } #
Array of attributes applied to the indexer.
public CodeLinkTM BaseDeclaringType { get; init; } #
If the indexer overrides another member, this property returns the base type that originally declared the member. null if the indexer doesn't override anything.
public string ExampleDocComment { get; init; } #
example documentation comment for the indexer. null if the doc comment is not provided.
public ExceptionTM[] Exceptions { get; init; } #
A collection of user-documented exceptions (using the exception XML tag) that the indexer might throw.
public CodeLinkTM ExplicitInterfaceType { get; init; } #
If the indexer is an explicit implementation, the type of the interface that explicitly declared it is returned. null if the indexer is not an explicit implementation.
public LanguageSpecificData<string[]> GetterModifiers { get; init; } #
Collection of the getter modifiers (possibly empty).
public bool HasGetter { get; init; } #
Checks if the indexer has getter.
public bool HasSetter { get; init; } #
Checks if the indexer has setter (returns true for init only setters as well).
public string Id { get; init; } #
Identifier of the indexer.
public CodeLinkTM[] ImplementedInterfaces { get; init; } #
Returns the types of the interfaces, whose part of contract this indexer implements.
public CodeLinkTM InheritedFrom { get; init; } #
If the indexer is inherited, this represents the type from which it originates. null if the indexer is not inherited.
public bool IsSetterInitOnly { get; init; } #
Checks if the property has init only setter.
public LanguageSpecificData<string[]> Modifiers { get; init; } #
Collection of indexer modifiers (e.g. public, static, etc.)
public ParameterTM[] Parameters { get; init; } #
Collection of index parameters.
public string RemarksDocComment { get; init; } #
remarks documentation comment for the indexer. null if the doc comment is not provided.
public string[] SeeAlsoDocComments { get; init; } #
Collection of seealso documentation comments for the indexer.
public LanguageSpecificData<string[]> SetterModifiers { get; init; } #
Collection of the setter modifiers (possibly empty).
public string SummaryDocComment { get; init; } #
summary documentation comment for the indexer. null if the doc comment is not provided.
public GenericTypeLinkTM Type { get; init; } #
Type of the indexer.
public string ValueDocComment { get; init; } #
value documentation comment for the indexer. null if the doc comment is not provided.