Class Project

Inheritance
System.Object
Entity
Entity<Guid>
BasicAggregateRoot<Guid>
AggregateRoot<Guid>
Project
Inherited Members
Namespace: Volo.Docs.Projects
Assembly: Volo.Docs.Domain.dll
Syntax
public class Project : AggregateRoot<Guid>, IAggregateRoot<Guid>, IEntity<Guid>, IAggregateRoot, IEntity, IGeneratesDomainEvents, IHasExtraProperties, IHasConcurrencyStamp

Constructors

Project()

Declaration
protected Project()

Project(Guid, String, String, String, String, String, String, String)

Declaration
public Project(Guid id, string name, string shortName, string documentStoreType, string format, string defaultDocumentName = "Index", string navigationDocumentName = "docs-nav.json", string parametersDocumentName = "docs-params.json")
Parameters
Type Name Description
Guid id
System.String name
System.String shortName
System.String documentStoreType
System.String format
System.String defaultDocumentName
System.String navigationDocumentName
System.String parametersDocumentName

Properties

DefaultDocumentName

The document for the initial page.

Declaration
public virtual string DefaultDocumentName { get; protected set; }
Property Value
Type Description
System.String

DocumentStoreType

The source of the documents (e.g. Github).

Declaration
public virtual string DocumentStoreType { get; protected set; }
Property Value
Type Description
System.String

Format

The format of the document (e.g. "md" for Markdown, "html" for HTML).

Declaration
public virtual string Format { get; protected set; }
Property Value
Type Description
System.String

LatestVersionBranchName

Declaration
public virtual string LatestVersionBranchName { get; set; }
Property Value
Type Description
System.String

MainWebsiteUrl

Declaration
public virtual string MainWebsiteUrl { get; set; }
Property Value
Type Description
System.String

MinimumVersion

Declaration
public virtual string MinimumVersion { get; set; }
Property Value
Type Description
System.String

Name

Name of the project for display purposes.

Declaration
public virtual string Name { get; protected set; }
Property Value
Type Description
System.String

NavigationDocumentName

The document to be used for the navigation menu (index).

Declaration
public virtual string NavigationDocumentName { get; protected set; }
Property Value
Type Description
System.String

ParametersDocumentName

The document to be used for the parameters file (index).

Declaration
public virtual string ParametersDocumentName { get; protected set; }
Property Value
Type Description
System.String

ShortName

A short name of the project to be seen in URLs.

Declaration
public virtual string ShortName { get; protected set; }
Property Value
Type Description
System.String

Methods

SetDefaultDocumentName(String)

Declaration
public void SetDefaultDocumentName(string defaultDocumentName)
Parameters
Type Name Description
System.String defaultDocumentName

SetFormat(String)

Declaration
public void SetFormat(string format)
Parameters
Type Name Description
System.String format

SetName(String)

Declaration
public void SetName(string name)
Parameters
Type Name Description
System.String name

SetNavigationDocumentName(String)

Declaration
public void SetNavigationDocumentName(string navigationDocumentName)
Parameters
Type Name Description
System.String navigationDocumentName

SetParametersDocumentName(String)

Declaration
public void SetParametersDocumentName(string parametersDocumentName)
Parameters
Type Name Description
System.String parametersDocumentName

Implements

IHasExtraProperties

Extension Methods