Class ItemViewModel

Namespace

Docfx.DataContracts.ManagedReference

Assembly

Docfx.Dotnet.dll

public class ItemViewModel : IOverwriteDocumentViewModel

Inheritance

object

ItemViewModel

Implements

IOverwriteDocumentViewModel

Inherited Members

object.Equals(object?)

object.Equals(object?, object?)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object?, object?)

object.ToString()

Properties

AdditionalNotes

[YamlMember(Alias = "additionalNotes")]
[JsonProperty("additionalNotes")]
[JsonPropertyName("additionalNotes")]
public AdditionalNotes AdditionalNotes { get; set; }

Property Value

AdditionalNotes

AssemblyNameList

[YamlMember(Alias = "assemblies")]
[MergeOption(MergeOption.Ignore)]
[JsonProperty("assemblies")]
[JsonPropertyName("assemblies")]
public List<string> AssemblyNameList { get; set; }

Property Value

List<string>

Attributes

[YamlMember(Alias = "attributes")]
[JsonProperty("attributes")]
[JsonPropertyName("attributes")]
[MergeOption(MergeOption.Ignore)]
public List<AttributeInfo> Attributes { get; set; }

Property Value

List<AttributeInfo>

Children

[YamlMember(Alias = "children")]
[MergeOption(MergeOption.Ignore)]
[JsonProperty("children")]
[JsonPropertyName("children")]
public List<string> Children { get; set; }

Property Value

List<string>

CommentId

[YamlMember(Alias = "commentId")]
[JsonProperty("commentId")]
[JsonPropertyName("commentId")]
public string CommentId { get; set; }

Property Value

string

Conceptual

The markdown content from the overwrite document

[YamlMember(Alias = "conceptual")]
[JsonProperty("conceptual")]
[JsonPropertyName("conceptual")]
public string Conceptual { get; set; }

Property Value

string

DerivedClasses

[YamlMember(Alias = "derivedClasses")]
[MergeOption(MergeOption.Ignore)]
[JsonProperty("derivedClasses")]
[JsonPropertyName("derivedClasses")]
public List<string> DerivedClasses { get; set; }

Property Value

List<string>

Documentation

The details for current overwrite document, containing the start/end line numbers, file path, and git info.

[YamlMember(Alias = "documentation")]
[JsonProperty("documentation")]
[JsonPropertyName("documentation")]
public SourceDetail Documentation { get; set; }

Property Value

SourceDetail

Examples

[YamlMember(Alias = "example")]
[JsonProperty("example")]
[JsonPropertyName("example")]
[MergeOption(MergeOption.Replace)]
public List<string> Examples { get; set; }

Property Value

List<string>

Exceptions

[YamlMember(Alias = "exceptions")]
[JsonProperty("exceptions")]
[JsonPropertyName("exceptions")]
public List<ExceptionInfo> Exceptions { get; set; }

Property Value

List<ExceptionInfo>

ExtensionMethods

[YamlMember(Alias = "extensionMethods")]
[MergeOption(MergeOption.Ignore)]
[JsonProperty("extensionMethods")]
[JsonPropertyName("extensionMethods")]
public List<string> ExtensionMethods { get; set; }

Property Value

List<string>

FullName

[YamlMember(Alias = "fullName")]
[JsonProperty("fullName")]
[JsonPropertyName("fullName")]
public string FullName { get; set; }

Property Value

string

FullNameForCSharp

[YamlIgnore]
[JsonIgnore]
[JsonIgnore]
public string FullNameForCSharp { get; set; }

Property Value

string

FullNameForVB

[YamlIgnore]
[JsonIgnore]
[JsonIgnore]
public string FullNameForVB { get; set; }

Property Value

string

FullNames

[ExtensibleMember("fullName.")]
[JsonIgnore]
[JsonIgnore]
public SortedList<string, string> FullNames { get; set; }

Property Value

SortedList<string, string>

Href

[YamlMember(Alias = "href")]
[JsonProperty("href")]
[JsonPropertyName("href")]
public string Href { get; set; }

Property Value

string

Id

[YamlMember(Alias = "id")]
[JsonProperty("id")]
[JsonPropertyName("id")]
public string Id { get; set; }

Property Value

string

Implements

[YamlMember(Alias = "implements")]
[MergeOption(MergeOption.Ignore)]
[JsonProperty("implements")]
[JsonPropertyName("implements")]
public List<string> Implements { get; set; }

Property Value

List<string>

Inheritance

[YamlMember(Alias = "inheritance")]
[MergeOption(MergeOption.Ignore)]
[JsonProperty("inheritance")]
[JsonPropertyName("inheritance")]
public List<string> Inheritance { get; set; }

Property Value

List<string>

InheritedMembers

[YamlMember(Alias = "inheritedMembers")]
[MergeOption(MergeOption.Ignore)]
[JsonProperty("inheritedMembers")]
[JsonPropertyName("inheritedMembers")]
public List<string> InheritedMembers { get; set; }

Property Value

List<string>

IsExplicitInterfaceImplementation

[YamlMember(Alias = "isEii")]
[JsonProperty("isEii")]
[JsonPropertyName("isEii")]
public bool IsExplicitInterfaceImplementation { get; set; }

Property Value

bool

IsExtensionMethod

[YamlMember(Alias = "isExtensionMethod")]
[JsonProperty("isExtensionMethod")]
[JsonPropertyName("isExtensionMethod")]
public bool IsExtensionMethod { get; set; }

Property Value

bool

Metadata

Gets the metadata.

[ExtensibleMember]
[JsonIgnore]
[JsonIgnore]
[JsonPropertyName("__metadata__")]
public Dictionary<string, object> Metadata { get; set; }

Property Value

Dictionary<string, object>

Name

[YamlMember(Alias = "name")]
[JsonProperty("name")]
[JsonPropertyName("name")]
public string Name { get; set; }

Property Value

string

NameForCSharp

[YamlIgnore]
[JsonIgnore]
[JsonIgnore]
public string NameForCSharp { get; set; }

Property Value

string

NameForVB

[YamlIgnore]
[JsonIgnore]
[JsonIgnore]
public string NameForVB { get; set; }

Property Value

string

NameWithType

[YamlMember(Alias = "nameWithType")]
[JsonProperty("nameWithType")]
[JsonPropertyName("nameWithType")]
public string NameWithType { get; set; }

Property Value

string

NameWithTypeForCSharp

[YamlIgnore]
[JsonIgnore]
[JsonIgnore]
public string NameWithTypeForCSharp { get; set; }

Property Value

string

NameWithTypeForVB

[YamlIgnore]
[JsonIgnore]
[JsonIgnore]
public string NameWithTypeForVB { get; set; }

Property Value

string

Names

[ExtensibleMember("name.")]
[JsonIgnore]
[JsonIgnore]
public SortedList<string, string> Names { get; set; }

Property Value

SortedList<string, string>

NamesWithType

[ExtensibleMember("nameWithType.")]
[JsonIgnore]
[JsonIgnore]
public SortedList<string, string> NamesWithType { get; set; }

Property Value

SortedList<string, string>

NamespaceName

[YamlMember(Alias = "namespace")]
[JsonProperty("namespace")]
[JsonPropertyName("namespace")]
public string NamespaceName { get; set; }

Property Value

string

Overload

[YamlMember(Alias = "overload")]
[JsonProperty("overload")]
[JsonPropertyName("overload")]
public string Overload { get; set; }

Property Value

string

Overridden

[YamlMember(Alias = "overridden")]
[JsonProperty("overridden")]
[JsonPropertyName("overridden")]
public string Overridden { get; set; }

Property Value

string

Parent

[YamlMember(Alias = "parent")]
[JsonProperty("parent")]
[JsonPropertyName("parent")]
public string Parent { get; set; }

Property Value

string

Platform

[YamlMember(Alias = "platform")]
[JsonProperty("platform")]
[JsonPropertyName("platform")]
[MergeOption(MergeOption.Replace)]
public List<string> Platform { get; set; }

Property Value

List<string>

Remarks

[YamlMember(Alias = "remarks")]
[JsonProperty("remarks")]
[JsonPropertyName("remarks")]
public string Remarks { get; set; }

Property Value

string

SeeAlsos

[YamlMember(Alias = "seealso")]
[JsonProperty("seealso")]
[JsonPropertyName("seealso")]
public List<LinkInfo> SeeAlsos { get; set; }

Property Value

List<LinkInfo>

SeeAlsosUidReference

[YamlIgnore]
[JsonIgnore]
[JsonIgnore]
public List<string> SeeAlsosUidReference { get; }

Property Value

List<string>

Source

[YamlMember(Alias = "source")]
[JsonProperty("source")]
[JsonPropertyName("source")]
public SourceDetail Source { get; set; }

Property Value

SourceDetail

Summary

[YamlMember(Alias = "summary")]
[JsonProperty("summary")]
[JsonPropertyName("summary")]
public string Summary { get; set; }

Property Value

string

SupportedLanguages

[YamlMember(Alias = "langs")]
[JsonProperty("langs")]
[JsonPropertyName("langs")]
public string[] SupportedLanguages { get; set; }

Property Value

string[]

Syntax

[YamlMember(Alias = "syntax")]
[JsonProperty("syntax")]
[JsonPropertyName("syntax")]
public SyntaxDetailViewModel Syntax { get; set; }

Property Value

SyntaxDetailViewModel

Type

[YamlMember(Alias = "type")]
[JsonProperty("type")]
[JsonPropertyName("type")]
public MemberType? Type { get; set; }

Property Value

MemberType?

Uid

The uid for this overwrite document, as defined in YAML header

[YamlMember(Alias = "uid")]
[JsonProperty("uid")]
[JsonPropertyName("uid")]
[MergeOption(MergeOption.MergeKey)]
public string Uid { get; set; }

Property Value

string