Skip to main content

Class ItemViewModel

Namespace: DocFxToTemplate.Models.DocFx
Assembly: DocFxToTemplate.dll
Source: src/DocFxToTemplate/Models/ItemViewModel.cs#L9

src/DocFxToTemplate/Models/ItemViewModel.cs#L9
public class ItemViewModel

Inheritance:
object <- ItemViewModel

Inherited Members:
object.Equals(object, object), object.Equals(object), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object, object), object.ToString()

Properties​

Properties​

src/DocFxToTemplate/Models/ItemViewModel.cs#L12
[JsonIgnore]
[YamlIgnore]
[IgnoreDataMember]
public ItemViewModel[] Properties { get; set; }

Property value​

ItemViewModel[]

Uid​

src/DocFxToTemplate/Models/DocFx/ItemViewModel.cs#L12
[YamlMember(Alias = "uid")]
[JsonPropertyName("uid")]
[MergeOption(MergeOption.MergeKey)]
public string? Uid { get; set; }

Property value​

string

CommentId​

src/DocFxToTemplate/Models/DocFx/ItemViewModel.cs#L17
[YamlMember(Alias = "commentId")]
[JsonPropertyName("commentId")]
public string? CommentId { get; set; }

Property value​

string

Fields​

src/DocFxToTemplate/Models/ItemViewModel.cs#L17
[JsonIgnore]
[YamlIgnore]
[IgnoreDataMember]
public ItemViewModel[] Fields { get; set; }

Property value​

ItemViewModel[]

Id​

src/DocFxToTemplate/Models/DocFx/ItemViewModel.cs#L21
[YamlMember(Alias = "id")]
[JsonPropertyName("id")]
public string? Id { get; set; }

Property value​

string

Methods​

src/DocFxToTemplate/Models/ItemViewModel.cs#L22
[JsonIgnore]
[YamlIgnore]
[IgnoreDataMember]
public ItemViewModel[] Methods { get; set; }

Property value​

ItemViewModel[]

IsExplicitInterfaceImplementation​

src/DocFxToTemplate/Models/DocFx/ItemViewModel.cs#L25
[YamlMember(Alias = "isEii")]
[JsonPropertyName("isEii")]
public bool IsExplicitInterfaceImplementation { get; set; }

Property value​

bool

Events​

src/DocFxToTemplate/Models/ItemViewModel.cs#L27
[JsonIgnore]
[YamlIgnore]
[IgnoreDataMember]
public ItemViewModel[] Events { get; set; }

Property value​

ItemViewModel[]

IsExtensionMethod​

src/DocFxToTemplate/Models/DocFx/ItemViewModel.cs#L29
[YamlMember(Alias = "isExtensionMethod")]
[JsonPropertyName("isExtensionMethod")]
public bool IsExtensionMethod { get; set; }

Property value​

bool

InheritanceRefs​

src/DocFxToTemplate/Models/ItemViewModel.cs#L32
[JsonIgnore]
[YamlIgnore]
[IgnoreDataMember]
public List<ReferenceViewModel> InheritanceRefs { get; set; }

Property value​

List<ReferenceViewModel>

Parent​

src/DocFxToTemplate/Models/DocFx/ItemViewModel.cs#L33
[YamlMember(Alias = "parent")]
[JsonPropertyName("parent")]
public string Parent { get; set; }

Property value​

string

DerivedClassesRefs​

src/DocFxToTemplate/Models/ItemViewModel.cs#L37
[JsonIgnore]
[YamlIgnore]
[IgnoreDataMember]
public List<ReferenceViewModel> DerivedClassesRefs { get; set; }

Property value​

List<ReferenceViewModel>

Children​

src/DocFxToTemplate/Models/DocFx/ItemViewModel.cs#L38
[YamlMember(Alias = "children")]
[MergeOption(MergeOption.Ignore)]
[JsonPropertyName("children")]
public List<string>? Children { get; set; }

Property value​

List<string>

ImplementsRefs​

src/DocFxToTemplate/Models/ItemViewModel.cs#L42
[JsonIgnore]
[YamlIgnore]
[IgnoreDataMember]
public List<ReferenceViewModel> ImplementsRefs { get; set; }

Property value​

List<ReferenceViewModel>

Href​

src/DocFxToTemplate/Models/DocFx/ItemViewModel.cs#L44
[YamlMember(Alias = "href")]
[JsonPropertyName("href")]
public string Href { get; set; }

Property value​

string

InheritedMembersRefs​

src/DocFxToTemplate/Models/ItemViewModel.cs#L47
[JsonIgnore]
[YamlIgnore]
[IgnoreDataMember]
public List<ReferenceViewModel> InheritedMembersRefs { get; set; }

Property value​

List<ReferenceViewModel>

SupportedLanguages​

src/DocFxToTemplate/Models/DocFx/ItemViewModel.cs#L48
[YamlMember(Alias = "langs")]
[JsonPropertyName("langs")]
public string[] SupportedLanguages { get; set; }

Property value​

string[]

ExtensionMethodsRefs​

src/DocFxToTemplate/Models/ItemViewModel.cs#L52
[JsonIgnore]
[YamlIgnore]
[IgnoreDataMember]
public List<ReferenceViewModel> ExtensionMethodsRefs { get; set; }

Property value​

List<ReferenceViewModel>

Name​

src/DocFxToTemplate/Models/DocFx/ItemViewModel.cs#L52
[YamlMember(Alias = "name")]
[JsonPropertyName("name")]
public string Name { get; set; }

Property value​

string

Names​

src/DocFxToTemplate/Models/DocFx/ItemViewModel.cs#L56
[ExtensibleMember("name.")]
[JsonIgnore]
public SortedList<string, string> Names { get; set; }

Property value​

SortedList<string, string>

src/DocFxToTemplate/Models/ItemViewModel.cs#L58
[JsonIgnore]
[YamlIgnore]
[IgnoreDataMember]
public MarkdownLink? Link { get; set; }

Property value​

MarkdownLink

NameForCSharp​

src/DocFxToTemplate/Models/DocFx/ItemViewModel.cs#L60
[YamlIgnore]
[JsonIgnore]
public string NameForCSharp { get; set; }

Property value​

string

NameForVB​

src/DocFxToTemplate/Models/DocFx/ItemViewModel.cs#L78
[YamlIgnore]
[JsonIgnore]
public string NameForVB { get; set; }

Property value​

string

NameWithType​

src/DocFxToTemplate/Models/DocFx/ItemViewModel.cs#L96
[YamlMember(Alias = "nameWithType")]
[JsonPropertyName("nameWithType")]
public string NameWithType { get; set; }

Property value​

string

NamesWithType​

src/DocFxToTemplate/Models/DocFx/ItemViewModel.cs#L100
[ExtensibleMember("nameWithType.")]
[JsonIgnore]
public SortedList<string, string> NamesWithType { get; set; }

Property value​

SortedList<string, string>

NameWithTypeForCSharp​

src/DocFxToTemplate/Models/DocFx/ItemViewModel.cs#L104
[YamlIgnore]
[JsonIgnore]
public string NameWithTypeForCSharp { get; set; }

Property value​

string

NameWithTypeForVB​

src/DocFxToTemplate/Models/DocFx/ItemViewModel.cs#L122
[YamlIgnore]
[JsonIgnore]
public string NameWithTypeForVB { get; set; }

Property value​

string

FullName​

src/DocFxToTemplate/Models/DocFx/ItemViewModel.cs#L140
[YamlMember(Alias = "fullName")]
[JsonPropertyName("fullName")]
public string FullName { get; set; }

Property value​

string

FullNames​

src/DocFxToTemplate/Models/DocFx/ItemViewModel.cs#L144
[ExtensibleMember("fullName.")]
[JsonIgnore]
public SortedList<string, string> FullNames { get; set; }

Property value​

SortedList<string, string>

FullNameForCSharp​

src/DocFxToTemplate/Models/DocFx/ItemViewModel.cs#L148
[YamlIgnore]
[JsonIgnore]
public string FullNameForCSharp { get; set; }

Property value​

string

FullNameForVB​

src/DocFxToTemplate/Models/DocFx/ItemViewModel.cs#L166
[YamlIgnore]
[JsonIgnore]
public string FullNameForVB { get; set; }

Property value​

string

Type​

src/DocFxToTemplate/Models/DocFx/ItemViewModel.cs#L184
[YamlMember(Alias = "type")]
[JsonPropertyName("type")]
public MemberType? Type { get; set; }

Property value​

MemberType?

Source​

src/DocFxToTemplate/Models/DocFx/ItemViewModel.cs#L188
[YamlMember(Alias = "source")]
[JsonPropertyName("source")]
public SourceDetail? Source { get; set; }

Property value​

SourceDetail

Documentation​

src/DocFxToTemplate/Models/DocFx/ItemViewModel.cs#L192
[YamlMember(Alias = "documentation")]
[JsonPropertyName("documentation")]
public SourceDetail Documentation { get; set; }

Property value​

SourceDetail

AssemblyNameList​

src/DocFxToTemplate/Models/DocFx/ItemViewModel.cs#L196
[YamlMember(Alias = "assemblies")]
[MergeOption(MergeOption.Ignore)]
[JsonPropertyName("assemblies")]
public List<string>? AssemblyNameList { get; set; }

Property value​

List<string>

NamespaceName​

src/DocFxToTemplate/Models/DocFx/ItemViewModel.cs#L201
[YamlMember(Alias = "namespace")]
[JsonPropertyName("namespace")]
public string NamespaceName { get; set; }

Property value​

string

Summary​

src/DocFxToTemplate/Models/DocFx/ItemViewModel.cs#L206
[YamlMember(Alias = "summary")]
[JsonPropertyName("summary")]
public string Summary { get; set; }

Property value​

string

AdditionalNotes​

src/DocFxToTemplate/Models/DocFx/ItemViewModel.cs#L211
[YamlMember(Alias = "additionalNotes")]
[JsonPropertyName("additionalNotes")]
public AdditionalNotes AdditionalNotes { get; set; }

Property value​

AdditionalNotes

Remarks​

src/DocFxToTemplate/Models/DocFx/ItemViewModel.cs#L215
[YamlMember(Alias = "remarks")]
[JsonPropertyName("remarks")]
public string Remarks { get; set; }

Property value​

string

Examples​

src/DocFxToTemplate/Models/DocFx/ItemViewModel.cs#L220
[YamlMember(Alias = "example")]
[JsonPropertyName("example")]
[MergeOption(MergeOption.Replace)]
public List<string>? Examples { get; set; }

Property value​

List<string>

Syntax​

src/DocFxToTemplate/Models/DocFx/ItemViewModel.cs#L226
[YamlMember(Alias = "syntax")]
[JsonPropertyName("syntax")]
public SyntaxDetailViewModel? Syntax { get; set; }

Property value​

SyntaxDetailViewModel

Overridden​

src/DocFxToTemplate/Models/DocFx/ItemViewModel.cs#L230
[YamlMember(Alias = "overridden")]
[JsonPropertyName("overridden")]
public string Overridden { get; set; }

Property value​

string

Overload​

src/DocFxToTemplate/Models/DocFx/ItemViewModel.cs#L235
[YamlMember(Alias = "overload")]
[JsonPropertyName("overload")]
public string Overload { get; set; }

Property value​

string

Exceptions​

src/DocFxToTemplate/Models/DocFx/ItemViewModel.cs#L240
[YamlMember(Alias = "exceptions")]
[JsonPropertyName("exceptions")]
public List<ExceptionInfo>? Exceptions { get; set; }

Property value​

List<ExceptionInfo>

SeeAlsos​

src/DocFxToTemplate/Models/DocFx/ItemViewModel.cs#L244
[YamlMember(Alias = "seealso")]
[JsonPropertyName("seealso")]
public List<LinkInfo>? SeeAlsos { get; set; }

Property value​

List<LinkInfo>

SeeAlsosUidReference​

src/DocFxToTemplate/Models/DocFx/ItemViewModel.cs#L248
[YamlIgnore]
[JsonIgnore]
public List<string> SeeAlsosUidReference { get; }

Property value​

List<string>

Inheritance​

src/DocFxToTemplate/Models/DocFx/ItemViewModel.cs#L254
[YamlMember(Alias = "inheritance")]
[MergeOption(MergeOption.Ignore)]
[JsonPropertyName("inheritance")]
public List<string>? Inheritance { get; set; }

Property value​

List<string>

DerivedClasses​

src/DocFxToTemplate/Models/DocFx/ItemViewModel.cs#L260
[YamlMember(Alias = "derivedClasses")]
[MergeOption(MergeOption.Ignore)]
[JsonPropertyName("derivedClasses")]
public List<string>? DerivedClasses { get; set; }

Property value​

List<string>

Implements​

src/DocFxToTemplate/Models/DocFx/ItemViewModel.cs#L266
[YamlMember(Alias = "implements")]
[MergeOption(MergeOption.Ignore)]
[JsonPropertyName("implements")]
public List<string>? Implements { get; set; }

Property value​

List<string>

InheritedMembers​

src/DocFxToTemplate/Models/DocFx/ItemViewModel.cs#L272
[YamlMember(Alias = "inheritedMembers")]
[MergeOption(MergeOption.Ignore)]
[JsonPropertyName("inheritedMembers")]
public List<string>? InheritedMembers { get; set; }

Property value​

List<string>

ExtensionMethods​

src/DocFxToTemplate/Models/DocFx/ItemViewModel.cs#L278
[YamlMember(Alias = "extensionMethods")]
[MergeOption(MergeOption.Ignore)]
[JsonPropertyName("extensionMethods")]
public List<string>? ExtensionMethods { get; set; }

Property value​

List<string>

Conceptual​

src/DocFxToTemplate/Models/DocFx/ItemViewModel.cs#L284
[YamlMember(Alias = "conceptual")]
[JsonPropertyName("conceptual")]
public string Conceptual { get; set; }

Property value​

string

Platform​

src/DocFxToTemplate/Models/DocFx/ItemViewModel.cs#L289
[YamlMember(Alias = "platform")]
[JsonPropertyName("platform")]
[MergeOption(MergeOption.Replace)]
public List<string>? Platform { get; set; }

Property value​

List<string>

Attributes​

src/DocFxToTemplate/Models/DocFx/ItemViewModel.cs#L294
[YamlMember(Alias = "attributes")]
[JsonPropertyName("attributes")]
[MergeOption(MergeOption.Ignore)]
public List<AttributeInfo>? Attributes { get; set; }

Property value​

List<AttributeInfo>

Metadata​

src/DocFxToTemplate/Models/DocFx/ItemViewModel.cs#L299
[ExtensibleMember]
[JsonIgnore]
public Dictionary<string, object> Metadata { get; set; }

Property value​

Dictionary<string, object>