Class IndexModel

Inheritance

object

PageModel

AbpPageModel

IndexModel

Implements

IAsyncPageFilter

IPageFilter

IFilterMetadata

Inherited Members

AbpPageModel.NoContent()

AbpPageModel.ValidateModel()

AbpPageModel.CheckPolicyAsync(string)

AbpPageModel.PartialView<TModel>(string, TModel)

AbpPageModel.CreateLocalizer()

AbpPageModel.RedirectSafelyAsync(string, string)

AbpPageModel.GetRedirectUrlAsync(string, string)

AbpPageModel.NormalizeReturnUrlAsync(string)

AbpPageModel.GetAppHomeUrlAsync()

AbpPageModel.LazyServiceProvider

AbpPageModel.ServiceProvider

AbpPageModel.Clock

AbpPageModel.Alerts

AbpPageModel.UnitOfWorkManager

AbpPageModel.ObjectMapperContext

AbpPageModel.ObjectMapper

AbpPageModel.GuidGenerator

AbpPageModel.LoggerFactory

AbpPageModel.StringLocalizerFactory

AbpPageModel.L

AbpPageModel.LocalizationResourceType

AbpPageModel.CurrentUser

AbpPageModel.CurrentTenant

AbpPageModel.SettingProvider

AbpPageModel.ModelValidator

AbpPageModel.AuthorizationService

AbpPageModel.AlertManager

AbpPageModel.CurrentUnitOfWork

AbpPageModel.Logger

AbpPageModel.AppUrlProvider

PageModel.TryUpdateModelAsync<TModel>(TModel)

PageModel.TryUpdateModelAsync<TModel>(TModel, string)

PageModel.TryUpdateModelAsync<TModel>(TModel, string, IValueProvider)

PageModel.TryUpdateModelAsync<TModel>(TModel, string, params Expression<Func<TModel, object>>[])

PageModel.TryUpdateModelAsync<TModel>(TModel, string, Func<ModelMetadata, bool>)

PageModel.TryUpdateModelAsync<TModel>(TModel, string, IValueProvider, params Expression<Func<TModel, object>>[])

PageModel.TryUpdateModelAsync<TModel>(TModel, string, IValueProvider, Func<ModelMetadata, bool>)

PageModel.TryUpdateModelAsync(object, Type, string)

PageModel.TryUpdateModelAsync(object, Type, string, IValueProvider, Func<ModelMetadata, bool>)

PageModel.BadRequest()

PageModel.BadRequest(object)

PageModel.BadRequest(ModelStateDictionary)

PageModel.Challenge()

PageModel.Challenge(params string[])

PageModel.Challenge(AuthenticationProperties)

PageModel.Challenge(AuthenticationProperties, params string[])

PageModel.Content(string)

PageModel.Content(string, string)

PageModel.Content(string, string, Encoding)

PageModel.Content(string, MediaTypeHeaderValue)

PageModel.Forbid()

PageModel.Forbid(params string[])

PageModel.Forbid(AuthenticationProperties)

PageModel.Forbid(AuthenticationProperties, params string[])

PageModel.File(byte[], string)

PageModel.File(byte[], string, string)

PageModel.File(Stream, string)

PageModel.File(Stream, string, string)

PageModel.File(string, string)

PageModel.File(string, string, string)

PageModel.LocalRedirect(string)

PageModel.LocalRedirectPermanent(string)

PageModel.LocalRedirectPreserveMethod(string)

PageModel.LocalRedirectPermanentPreserveMethod(string)

PageModel.NotFound()

PageModel.NotFound(object)

PageModel.Page()

PageModel.PhysicalFile(string, string)

PageModel.PhysicalFile(string, string, string)

PageModel.Redirect(string)

PageModel.RedirectPermanent(string)

PageModel.RedirectPreserveMethod(string)

PageModel.RedirectPermanentPreserveMethod(string)

PageModel.RedirectToAction(string)

PageModel.RedirectToAction(string, object)

PageModel.RedirectToAction(string, string)

PageModel.RedirectToAction(string, string, object)

PageModel.RedirectToAction(string, string, string)

PageModel.RedirectToAction(string, string, object, string)

PageModel.RedirectToActionPreserveMethod(string, string, object, string)

PageModel.RedirectToActionPermanent(string)

PageModel.RedirectToActionPermanent(string, object)

PageModel.RedirectToActionPermanent(string, string)

PageModel.RedirectToActionPermanent(string, string, string)

PageModel.RedirectToActionPermanent(string, string, object)

PageModel.RedirectToActionPermanent(string, string, object, string)

PageModel.RedirectToActionPermanentPreserveMethod(string, string, object, string)

PageModel.RedirectToRoute(string)

PageModel.RedirectToRoute(object)

PageModel.RedirectToRoute(string, object)

PageModel.RedirectToRoute(string, string)

PageModel.RedirectToRoute(string, object, string)

PageModel.RedirectToRoutePreserveMethod(string, object, string)

PageModel.RedirectToRoutePermanent(string)

PageModel.RedirectToRoutePermanent(object)

PageModel.RedirectToRoutePermanent(string, object)

PageModel.RedirectToRoutePermanent(string, string)

PageModel.RedirectToRoutePermanent(string, object, string)

PageModel.RedirectToRoutePermanentPreserveMethod(string, object, string)

PageModel.RedirectToPage()

PageModel.RedirectToPage(object)

PageModel.RedirectToPage(string)

PageModel.RedirectToPage(string, string)

PageModel.RedirectToPage(string, string, object)

PageModel.RedirectToPage(string, object)

PageModel.RedirectToPage(string, string, string)

PageModel.RedirectToPage(string, string, object, string)

PageModel.RedirectToPagePermanent(string)

PageModel.RedirectToPagePermanent(string, object)

PageModel.RedirectToPagePermanent(string, string)

PageModel.RedirectToPagePermanent(string, string, object)

PageModel.RedirectToPagePermanent(string, string, string)

PageModel.RedirectToPagePermanent(string, object, string)

PageModel.RedirectToPagePermanent(string, string, object, string)

PageModel.RedirectToPagePreserveMethod(string, string, object, string)

PageModel.RedirectToPagePermanentPreserveMethod(string, string, object, string)

PageModel.SignIn(ClaimsPrincipal, string)

PageModel.SignIn(ClaimsPrincipal, AuthenticationProperties, string)

PageModel.SignOut(params string[])

PageModel.SignOut(AuthenticationProperties, params string[])

PageModel.StatusCode(int)

PageModel.StatusCode(int, object)

PageModel.Unauthorized()

PageModel.Partial(string)

PageModel.Partial(string, object)

PageModel.ViewComponent(string)

PageModel.ViewComponent(Type)

PageModel.ViewComponent(string, object)

PageModel.ViewComponent(Type, object)

PageModel.TryValidateModel(object)

PageModel.TryValidateModel(object, string)

PageModel.OnPageHandlerSelected(PageHandlerSelectedContext)

PageModel.OnPageHandlerExecuting(PageHandlerExecutingContext)

PageModel.OnPageHandlerExecuted(PageHandlerExecutedContext)

PageModel.OnPageHandlerSelectionAsync(PageHandlerSelectedContext)

PageModel.OnPageHandlerExecutionAsync(PageHandlerExecutingContext, PageHandlerExecutionDelegate)

PageModel.PageContext

PageModel.HttpContext

PageModel.Request

PageModel.Response

PageModel.RouteData

PageModel.ModelState

PageModel.User

PageModel.TempData

PageModel.Url

PageModel.MetadataProvider

PageModel.ViewData

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Volo.Docs.Pages.Documents.Project

Assembly: Volo.Docs.Web.dll

Syntax

public class IndexModel : AbpPageModel, IAsyncPageFilter, IPageFilter, IFilterMetadata

Constructors

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

Declaration

public IndexModel(IDocumentAppService documentAppService, IDocumentToHtmlConverterFactory documentToHtmlConverterFactory, IProjectAppService projectAppService, IOptions<DocsUiOptions> options, IDocumentSectionRenderer documentSectionRenderer)

Parameters

Type	Name	Description
IDocumentAppService	documentAppService
IDocumentToHtmlConverterFactory	documentToHtmlConverterFactory
IProjectAppService	projectAppService
IOptions<DocsUiOptions>	options
IDocumentSectionRenderer	documentSectionRenderer

Properties

AlternativeOptionLinkQueries

Declaration

public List<string> AlternativeOptionLinkQueries { get; set; }

Property Value

Type	Description
List<string>

DefaultLanguageCode

Declaration

public string DefaultLanguageCode { get; set; }

Property Value

Type	Description
string

DocsLinkGenerator

Declaration

protected IDocsLinkGenerator DocsLinkGenerator { get; }

Property Value

Type	Description
IDocsLinkGenerator

Document

Declaration

public DocumentWithDetailsDto Document { get; }

Property Value

Type	Description
DocumentWithDetailsDto

DocumentFound

Declaration

public bool DocumentFound { get; set; }

Property Value

Type	Description
bool

DocumentLanguageCode

Declaration

public string DocumentLanguageCode { get; set; }

Property Value

Type	Description
string

DocumentName

Declaration

[BindProperty(SupportsGet = true)]
public string DocumentName { get; set; }

Property Value

Type	Description
string

DocumentNameWithExtension

Declaration

public string DocumentNameWithExtension { get; }

Property Value

Type	Description
string

DocumentNavigationsDto

Declaration

public DocumentNavigationsDto DocumentNavigationsDto { get; }

Property Value

Type	Description
DocumentNavigationsDto

DocumentPageTitle

Declaration

public string DocumentPageTitle { get; }

Property Value

Type	Description
string

DocumentPreferences

Declaration

public DocumentParametersDto DocumentPreferences { get; set; }

Property Value

Type	Description
DocumentParametersDto

DocumentsUrlPrefix

Declaration

public string DocumentsUrlPrefix { get; set; }

Property Value

Type	Description
string

FullSearchEnabled

Declaration

public bool FullSearchEnabled { get; set; }

Property Value

Type	Description
bool

IsLatestVersion

Declaration

public bool IsLatestVersion { get; }

Property Value

Type	Description
bool

IsVersionPreview

Declaration

public bool IsVersionPreview { get; set; }

Property Value

Type	Description
bool

LanguageCode

Declaration

[BindProperty(SupportsGet = true)]
public string LanguageCode { get; set; }

Property Value

Type	Description
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
List<SelectListItem>

LatestVersionInfo

Declaration

public VersionInfoViewModel LatestVersionInfo { get; }

Property Value

Type	Description
VersionInfoViewModel

LoadSuccess

Declaration

public bool LoadSuccess { get; }

Property Value

Type	Description
bool

LocalEventBus

Declaration

protected ILocalEventBus LocalEventBus { get; }

Property Value

Type	Description
ILocalEventBus

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
bool

ProjectName

Declaration

[BindProperty(SupportsGet = true)]
public string ProjectName { get; set; }

Property Value

Type	Description
string

ProjectSelectItems

Declaration

public List<SelectListItem> ProjectSelectItems { get; }

Property Value

Type	Description
List<SelectListItem>

ShowProjectsCombobox

Declaration

public bool ShowProjectsCombobox { get; set; }

Property Value

Type	Description
bool

ShowProjectsComboboxLabel

Declaration

public bool ShowProjectsComboboxLabel { get; set; }

Property Value

Type	Description
bool

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
string

VersionSelectItems

Declaration

public List<SelectListItem> VersionSelectItems { get; }

Property Value

Type	Description
List<SelectListItem>

Methods

BuildDocumentUrl(string, string, string, string)

Declaration

public string BuildDocumentUrl(string projectName, string languageCode, string version, string documentName)

Parameters

Type	Name	Description
string	projectName
string	languageCode
string	version
string	documentName

Returns

Type	Description
string

CreateDocumentLink(string)

Declaration

public string CreateDocumentLink(string documentName)

Parameters

Type	Name	Description
string	documentName

Returns

Type	Description
string

CreateVersionLink(VersionInfoViewModel, string, string)

Declaration

public string CreateVersionLink(VersionInfoViewModel latestVersion, string version, string documentName = null)

Parameters

Type	Name	Description
VersionInfoViewModel	latestVersion
string	version
string	documentName

Returns

Type	Description
string

GetDescription()

Declaration

public string GetDescription()

Returns

Type	Description
string

GetFullUrlOfTheLatestDocument()

Declaration

public string GetFullUrlOfTheLatestDocument()

Returns

Type	Description
string

GetSpecificVersionOrLatest()

Declaration

public string GetSpecificVersionOrLatest()

Returns

Type	Description
string

OnGetAsync()

Declaration

public virtual Task<IActionResult> OnGetAsync()

Returns

Type	Description
Task<IActionResult>

OnSectionRenderingErrorAsync(Exception)

Declaration

protected virtual Task OnSectionRenderingErrorAsync(Exception e)

Parameters

Type	Name	Description
Exception	e

Returns

Type	Description
Task

Implements

IAsyncPageFilter

IPageFilter

IFilterMetadata

Extension Methods

AbpObjectExtensions.As<T>(object)

AbpObjectExtensions.To<T>(object)

LockExtensions.Locking(object, Action)

LockExtensions.Locking<TResult>(object, Func<TResult>)

AbpObjectExtensions.If<T>(T, bool, Action<T>)

AbpObjectExtensions.If<T>(T, bool, Func<T, T>)

AbpObjectExtensions.IsIn<T>(T, IEnumerable<T>)

AbpObjectExtensions.IsIn<T>(T, params T[])

AbpQueryableExtensions.OrderByIf<T, TQueryable>(TQueryable, bool, string)

AbpQueryableExtensions.PageBy<T, TQueryable>(TQueryable, int, int)

AbpQueryableExtensions.WhereIf<T, TQueryable>(TQueryable, bool, Expression<Func<T, bool>>)

AbpQueryableExtensions.WhereIf<T, TQueryable>(TQueryable, bool, Expression<Func<T, int, bool>>)

AbpOpenIddictQueryableExtensions.SkipIf<T, TQueryable>(TQueryable, bool, int?)

AbpOpenIddictQueryableExtensions.TakeIf<T, TQueryable>(TQueryable, bool, int?)

LockExtensions.Locking<T>(T, Action<T>)

LockExtensions.Locking<T, TResult>(T, Func<T, TResult>)