public class EventTM

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

Constructors

public EventTM(string Id, string Name, GenericTypeLinkTM Type, LanguageSpecificData<string[]> Modifiers, AttributeTM[] Attributes, string SummaryDocComment, string RemarksDocComment, string ExampleDocComment, string[] SeeAlsoDocComments, ExceptionTM[] Exceptions, CodeLinkTM InheritedFrom, CodeLinkTM BaseDeclaringType, CodeLinkTM ExplicitInterfaceType, CodeLinkTM[] ImplementedInterfaces) #
Represents the template model for an event.
Parameters
string Id
Identifier of the event.
string Name
Name of the event.
GenericTypeLinkTM Type
Type of the event.
LanguageSpecificData<string[]> Modifiers
Collection of modifiers for the event (e.g. public, static, etc.)
AttributeTM[] Attributes
Array of attributes applied to the event.
string SummaryDocComment
summary documentation comment for the event. null if the doc comment is not provided.
string RemarksDocComment
remarks documentation comment for the event. null if the doc comment is not provided.
string ExampleDocComment
example documentation comment for the event. null if the doc comment is not provided.
string[] SeeAlsoDocComments
Collection of seealso documentation comments for the event.
ExceptionTM[] Exceptions
A collection of user-documented exceptions (using the exception XML tag) that the event might throw.
CodeLinkTM InheritedFrom
If the event is inherited, this represents the type from which it originates. null if the event is not inherited.
CodeLinkTM BaseDeclaringType
If the event overrides another member, this property returns the base type that originally declared the member. null is returned if the event doesn't override anything.
CodeLinkTM ExplicitInterfaceType
If the event is an explicit implementation, the type of the interface that explicitly declared it is returned. null if the event is not an explicit implementation.
CodeLinkTM[] ImplementedInterfaces
Returns the types of the interfaces, whose part of contract this event implements.

Properties

public AttributeTM[] Attributes { get; init; } #
Array of attributes applied to the event.
public CodeLinkTM BaseDeclaringType { get; init; } #
If the event overrides another member, this property returns the base type that originally declared the member. null is returned if the event doesn't override anything.
public string ExampleDocComment { get; init; } #
example documentation comment for the event. 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 event might throw.
public CodeLinkTM ExplicitInterfaceType { get; init; } #
If the event is an explicit implementation, the type of the interface that explicitly declared it is returned. null if the event is not an explicit implementation.
public string Id { get; init; } #
Identifier of the event.
public CodeLinkTM[] ImplementedInterfaces { get; init; } #
Returns the types of the interfaces, whose part of contract this event implements.
public CodeLinkTM InheritedFrom { get; init; } #
If the event is inherited, this represents the type from which it originates. null if the event is not inherited.
public LanguageSpecificData<string[]> Modifiers { get; init; } #
Collection of modifiers for the event (e.g. public, static, etc.)
public string Name { get; init; } #
Name of the event.
public string RemarksDocComment { get; init; } #
remarks documentation comment for the event. null if the doc comment is not provided.
public string[] SeeAlsoDocComments { get; init; } #
Collection of seealso documentation comments for the event.
public string SummaryDocComment { get; init; } #
summary documentation comment for the event. null if the doc comment is not provided.
public GenericTypeLinkTM Type { get; init; } #
Type of the event.