Class IndexModel

Inheritance
System.Object
IndexModel
Namespace: Volo.Docs.Pages.Documents.Project
Assembly: Volo.Docs.Web.dll
Syntax
public class IndexModel : AbpPageModel

Constructors

IndexModel(IDocumentAppService, IDocumentToHtmlConverterFactory, IProjectAppService, IOptions<DocsUiOptions>, IDocumentSectionRenderer, IVersionHelper)

Declaration
public IndexModel(IDocumentAppService documentAppService, IDocumentToHtmlConverterFactory documentToHtmlConverterFactory, IProjectAppService projectAppService, IOptions<DocsUiOptions> options, IDocumentSectionRenderer documentSectionRenderer, IVersionHelper versionHelper)
Parameters
Type Name Description
IDocumentAppService documentAppService
IDocumentToHtmlConverterFactory documentToHtmlConverterFactory
IProjectAppService projectAppService
Microsoft.Extensions.Options.IOptions<DocsUiOptions> options
IDocumentSectionRenderer documentSectionRenderer
IVersionHelper versionHelper

Properties

AlternativeOptionLinkQueries

Declaration
public List<string> AlternativeOptionLinkQueries { get; set; }
Property Value
Type Description
System.Collections.Generic.List<System.String>

DefaultLanguageCode

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

Document

Declaration
public DocumentWithDetailsDto Document { get; }
Property Value
Type Description
DocumentWithDetailsDto

DocumentFound

Declaration
public bool DocumentFound { get; set; }
Property Value
Type Description
System.Boolean

DocumentLanguageCode

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

DocumentName

Declaration
[BindProperty(SupportsGet = true)]
public string DocumentName { get; set; }
Property Value
Type Description
System.String

DocumentNameWithExtension

Declaration
public string DocumentNameWithExtension { get; }
Property Value
Type Description
System.String

DocumentPreferences

Declaration
public DocumentParametersDto DocumentPreferences { get; set; }
Property Value
Type Description
DocumentParametersDto

DocumentsUrlPrefix

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

FullSearchEnabled

Declaration
public bool FullSearchEnabled { get; set; }
Property Value
Type Description
System.Boolean

LanguageCode

Declaration
[BindProperty(SupportsGet = true)]
public string LanguageCode { get; set; }
Property Value
Type Description
System.String

LanguageConfig

Declaration
public LanguageConfig LanguageConfig { get; set; }
Property Value
Type Description
LanguageConfig

LanguageSelectListItems

Declaration
public List<SelectListItem> LanguageSelectListItems { get; set; }
Property Value
Type Description
System.Collections.Generic.List<Microsoft.AspNetCore.Mvc.Rendering.SelectListItem>

LatestVersionInfo

Declaration
public VersionInfoViewModel LatestVersionInfo { get; }
Property Value
Type Description
VersionInfoViewModel

LoadSuccess

Declaration
public bool LoadSuccess { get; }
Property Value
Type Description
System.Boolean

Navigation

Declaration
public NavigationNode Navigation { get; }
Property Value
Type Description
NavigationNode

Project

Declaration
public ProjectDto Project { get; set; }
Property Value
Type Description
ProjectDto

ProjectFound

Declaration
public bool ProjectFound { get; set; }
Property Value
Type Description
System.Boolean

ProjectName

Declaration
[BindProperty(SupportsGet = true)]
public string ProjectName { get; set; }
Property Value
Type Description
System.String

ProjectSelectItems

Declaration
public List<SelectListItem> ProjectSelectItems { get; }
Property Value
Type Description
System.Collections.Generic.List<Microsoft.AspNetCore.Mvc.Rendering.SelectListItem>

ShowProjectsCombobox

Declaration
public bool ShowProjectsCombobox { get; set; }
Property Value
Type Description
System.Boolean

UserPreferences

Declaration
public DocumentRenderParameters UserPreferences { get; set; }
Property Value
Type Description
DocumentRenderParameters

Version

Declaration
[BindProperty(SupportsGet = true)]
public string Version { get; set; }
Property Value
Type Description
System.String

VersionSelectItems

Declaration
public List<SelectListItem> VersionSelectItems { get; }
Property Value
Type Description
System.Collections.Generic.List<Microsoft.AspNetCore.Mvc.Rendering.SelectListItem>

Methods

CreateVersionLink(VersionInfoViewModel, String, String)

Declaration
public string CreateVersionLink(VersionInfoViewModel latestVersion, string version, string documentName = null)
Parameters
Type Name Description
VersionInfoViewModel latestVersion
System.String version
System.String documentName
Returns
Type Description
System.String

GetDescription()

Declaration
public string GetDescription()
Returns
Type Description
System.String

GetSpecificVersionOrLatest()

Declaration
public string GetSpecificVersionOrLatest()
Returns
Type Description
System.String

OnGetAsync()

Declaration
public virtual Task<IActionResult> OnGetAsync()
Returns
Type Description
System.Threading.Tasks.Task<Microsoft.AspNetCore.Mvc.IActionResult>

Extension Methods