Abp.Web.Mvc.xml 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Abp.Web.Mvc</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Abp.Web.Mvc.AbpWebMvcModule">
  8. <summary>
  9. This module is used to build ASP.NET MVC web sites using Abp.
  10. </summary>
  11. </member>
  12. <member name="M:Abp.Web.Mvc.AbpWebMvcModule.PreInitialize">
  13. <inheritdoc/>
  14. </member>
  15. <member name="M:Abp.Web.Mvc.AbpWebMvcModule.Initialize">
  16. <inheritdoc/>
  17. </member>
  18. <member name="M:Abp.Web.Mvc.AbpWebMvcModule.PostInitialize">
  19. <inheritdoc/>
  20. </member>
  21. <member name="T:Abp.Web.Mvc.Authorization.AbpMvcAuthorizeAttribute">
  22. <summary>
  23. This attribute is used on an action of an MVC <see cref="T:System.Web.Mvc.Controller"/>
  24. to make that action usable only by authorized users.
  25. </summary>
  26. </member>
  27. <member name="P:Abp.Web.Mvc.Authorization.AbpMvcAuthorizeAttribute.Permissions">
  28. <inheritdoc/>
  29. </member>
  30. <member name="P:Abp.Web.Mvc.Authorization.AbpMvcAuthorizeAttribute.RequireAllPermissions">
  31. <inheritdoc/>
  32. </member>
  33. <member name="M:Abp.Web.Mvc.Authorization.AbpMvcAuthorizeAttribute.#ctor(System.String[])">
  34. <summary>
  35. Creates a new instance of <see cref="T:Abp.Web.Mvc.Authorization.AbpMvcAuthorizeAttribute"/> class.
  36. </summary>
  37. <param name="permissions">A list of permissions to authorize</param>
  38. </member>
  39. <member name="T:Abp.Web.Mvc.Configuration.AbpMvcConfigurationExtensions">
  40. <summary>
  41. Defines extension methods to <see cref="T:Abp.Configuration.Startup.IModuleConfigurations"/> to allow to configure Abp.Web.Api module.
  42. </summary>
  43. </member>
  44. <member name="M:Abp.Web.Mvc.Configuration.AbpMvcConfigurationExtensions.AbpMvc(Abp.Configuration.Startup.IModuleConfigurations)">
  45. <summary>
  46. Used to configure Abp.Web.Api module.
  47. </summary>
  48. </member>
  49. <member name="P:Abp.Web.Mvc.Configuration.IAbpMvcConfiguration.DefaultUnitOfWorkAttribute">
  50. <summary>
  51. Default UnitOfWorkAttribute for all actions.
  52. </summary>
  53. </member>
  54. <member name="P:Abp.Web.Mvc.Configuration.IAbpMvcConfiguration.DefaultWrapResultAttribute">
  55. <summary>
  56. Default WrapResultAttribute for all actions.
  57. </summary>
  58. </member>
  59. <member name="P:Abp.Web.Mvc.Configuration.IAbpMvcConfiguration.IsValidationEnabledForControllers">
  60. <summary>
  61. Default: true.
  62. </summary>
  63. </member>
  64. <member name="P:Abp.Web.Mvc.Configuration.IAbpMvcConfiguration.IsAutomaticAntiForgeryValidationEnabled">
  65. <summary>
  66. Default: true.
  67. </summary>
  68. </member>
  69. <member name="P:Abp.Web.Mvc.Configuration.IAbpMvcConfiguration.IsAuditingEnabled">
  70. <summary>
  71. Used to enable/disable auditing for MVC controllers.
  72. Default: true.
  73. </summary>
  74. </member>
  75. <member name="P:Abp.Web.Mvc.Configuration.IAbpMvcConfiguration.IsAuditingEnabledForChildActions">
  76. <summary>
  77. Used to enable/disable auditing for child MVC actions.
  78. Default: false.
  79. </summary>
  80. </member>
  81. <member name="T:Abp.Web.Mvc.Controllers.AbpController">
  82. <summary>
  83. Base class for all MVC Controllers in Abp system.
  84. </summary>
  85. </member>
  86. <member name="P:Abp.Web.Mvc.Controllers.AbpController.AbpSession">
  87. <summary>
  88. Gets current session information.
  89. </summary>
  90. </member>
  91. <member name="P:Abp.Web.Mvc.Controllers.AbpController.EventBus">
  92. <summary>
  93. Gets the event bus.
  94. </summary>
  95. </member>
  96. <member name="P:Abp.Web.Mvc.Controllers.AbpController.PermissionManager">
  97. <summary>
  98. Reference to the permission manager.
  99. </summary>
  100. </member>
  101. <member name="P:Abp.Web.Mvc.Controllers.AbpController.SettingManager">
  102. <summary>
  103. Reference to the setting manager.
  104. </summary>
  105. </member>
  106. <member name="P:Abp.Web.Mvc.Controllers.AbpController.PermissionChecker">
  107. <summary>
  108. Reference to the permission checker.
  109. </summary>
  110. </member>
  111. <member name="P:Abp.Web.Mvc.Controllers.AbpController.FeatureManager">
  112. <summary>
  113. Reference to the feature manager.
  114. </summary>
  115. </member>
  116. <member name="P:Abp.Web.Mvc.Controllers.AbpController.FeatureChecker">
  117. <summary>
  118. Reference to the permission checker.
  119. </summary>
  120. </member>
  121. <member name="P:Abp.Web.Mvc.Controllers.AbpController.LocalizationManager">
  122. <summary>
  123. Reference to the localization manager.
  124. </summary>
  125. </member>
  126. <member name="P:Abp.Web.Mvc.Controllers.AbpController.ErrorInfoBuilder">
  127. <summary>
  128. Reference to the error info builder.
  129. </summary>
  130. </member>
  131. <member name="P:Abp.Web.Mvc.Controllers.AbpController.LocalizationSourceName">
  132. <summary>
  133. Gets/sets name of the localization source that is used in this application service.
  134. It must be set in order to use <see cref="M:Abp.Web.Mvc.Controllers.AbpController.L(System.String)"/> and <see cref="M:Abp.Web.Mvc.Controllers.AbpController.L(System.String,System.Globalization.CultureInfo)"/> methods.
  135. </summary>
  136. </member>
  137. <member name="P:Abp.Web.Mvc.Controllers.AbpController.LocalizationSource">
  138. <summary>
  139. Gets localization source.
  140. It's valid if <see cref="P:Abp.Web.Mvc.Controllers.AbpController.LocalizationSourceName"/> is set.
  141. </summary>
  142. </member>
  143. <member name="P:Abp.Web.Mvc.Controllers.AbpController.Logger">
  144. <summary>
  145. Reference to the logger to write logs.
  146. </summary>
  147. </member>
  148. <member name="P:Abp.Web.Mvc.Controllers.AbpController.ObjectMapper">
  149. <summary>
  150. Reference to the object to object mapper.
  151. </summary>
  152. </member>
  153. <member name="P:Abp.Web.Mvc.Controllers.AbpController.UnitOfWorkManager">
  154. <summary>
  155. Reference to <see cref="T:Abp.Domain.Uow.IUnitOfWorkManager"/>.
  156. </summary>
  157. </member>
  158. <member name="P:Abp.Web.Mvc.Controllers.AbpController.CurrentUnitOfWork">
  159. <summary>
  160. Gets current unit of work.
  161. </summary>
  162. </member>
  163. <member name="F:Abp.Web.Mvc.Controllers.AbpController._currentMethodInfo">
  164. <summary>
  165. MethodInfo for currently executing action.
  166. </summary>
  167. </member>
  168. <member name="F:Abp.Web.Mvc.Controllers.AbpController._wrapResultAttribute">
  169. <summary>
  170. WrapResultAttribute for currently executing action.
  171. </summary>
  172. </member>
  173. <member name="M:Abp.Web.Mvc.Controllers.AbpController.#ctor">
  174. <summary>
  175. Constructor.
  176. </summary>
  177. </member>
  178. <member name="M:Abp.Web.Mvc.Controllers.AbpController.L(System.String)">
  179. <summary>
  180. Gets localized string for given key name and current language.
  181. </summary>
  182. <param name="name">Key name</param>
  183. <returns>Localized string</returns>
  184. </member>
  185. <member name="M:Abp.Web.Mvc.Controllers.AbpController.L(System.String,System.Object[])">
  186. <summary>
  187. Gets localized string for given key name and current language with formatting strings.
  188. </summary>
  189. <param name="name">Key name</param>
  190. <param name="args">Format arguments</param>
  191. <returns>Localized string</returns>
  192. </member>
  193. <member name="M:Abp.Web.Mvc.Controllers.AbpController.L(System.String,System.Globalization.CultureInfo)">
  194. <summary>
  195. Gets localized string for given key name and specified culture information.
  196. </summary>
  197. <param name="name">Key name</param>
  198. <param name="culture">culture information</param>
  199. <returns>Localized string</returns>
  200. </member>
  201. <member name="M:Abp.Web.Mvc.Controllers.AbpController.L(System.String,System.Globalization.CultureInfo,System.Object[])">
  202. <summary>
  203. Gets localized string for given key name and current language with formatting strings.
  204. </summary>
  205. <param name="name">Key name</param>
  206. <param name="culture">culture information</param>
  207. <param name="args">Format arguments</param>
  208. <returns>Localized string</returns>
  209. </member>
  210. <member name="M:Abp.Web.Mvc.Controllers.AbpController.IsGrantedAsync(System.String)">
  211. <summary>
  212. Checks if current user is granted for a permission.
  213. </summary>
  214. <param name="permissionName">Name of the permission</param>
  215. </member>
  216. <member name="M:Abp.Web.Mvc.Controllers.AbpController.IsGranted(System.String)">
  217. <summary>
  218. Checks if current user is granted for a permission.
  219. </summary>
  220. <param name="permissionName">Name of the permission</param>
  221. </member>
  222. <member name="M:Abp.Web.Mvc.Controllers.AbpController.IsEnabledAsync(System.String)">
  223. <summary>
  224. Checks if given feature is enabled for current tenant.
  225. </summary>
  226. <param name="featureName">Name of the feature</param>
  227. <returns></returns>
  228. </member>
  229. <member name="M:Abp.Web.Mvc.Controllers.AbpController.IsEnabled(System.String)">
  230. <summary>
  231. Checks if given feature is enabled for current tenant.
  232. </summary>
  233. <param name="featureName">Name of the feature</param>
  234. <returns></returns>
  235. </member>
  236. <member name="M:Abp.Web.Mvc.Controllers.AbpController.Json(System.Object,System.String,System.Text.Encoding,System.Web.Mvc.JsonRequestBehavior)">
  237. <summary>
  238. Json the specified data, contentType, contentEncoding and behavior.
  239. </summary>
  240. <param name="data">Data.</param>
  241. <param name="contentType">Content type.</param>
  242. <param name="contentEncoding">Content encoding.</param>
  243. <param name="behavior">Behavior.</param>
  244. </member>
  245. <member name="T:Abp.Web.Mvc.Controllers.AbpScriptsController">
  246. <summary>
  247. This controller is used to create client side scripts
  248. to work with ABP.
  249. </summary>
  250. </member>
  251. <member name="M:Abp.Web.Mvc.Controllers.AbpScriptsController.#ctor(Abp.Web.MultiTenancy.IMultiTenancyScriptManager,Abp.Web.Settings.ISettingScriptManager,Abp.Web.Navigation.INavigationScriptManager,Abp.Web.Localization.ILocalizationScriptManager,Abp.Web.Authorization.IAuthorizationScriptManager,Abp.Web.Features.IFeaturesScriptManager,Abp.Web.Sessions.ISessionScriptManager,Abp.Web.Timing.ITimingScriptManager,Abp.Web.Security.ISecurityScriptManager,Abp.Web.Minifier.IJavaScriptMinifier)">
  252. <summary>
  253. Constructor.
  254. </summary>
  255. </member>
  256. <member name="M:Abp.Web.Mvc.Controllers.AbpScriptsController.GetScripts(System.String,System.Boolean)">
  257. <summary>
  258. Gets all needed scripts.
  259. </summary>
  260. </member>
  261. <member name="T:Abp.Web.Mvc.Controllers.ControllerConventionalRegistrar">
  262. <summary>
  263. Registers all MVC Controllers derived from <see cref="T:System.Web.Mvc.Controller"/>.
  264. </summary>
  265. </member>
  266. <member name="M:Abp.Web.Mvc.Controllers.ControllerConventionalRegistrar.RegisterAssembly(Abp.Dependency.IConventionalRegistrationContext)">
  267. <inheritdoc/>
  268. </member>
  269. <member name="T:Abp.Web.Mvc.Controllers.Results.AbpJsonResult">
  270. <summary>
  271. This class is used to override returning Json results from MVC controllers.
  272. </summary>
  273. </member>
  274. <member name="P:Abp.Web.Mvc.Controllers.Results.AbpJsonResult.CamelCase">
  275. <summary>
  276. Gets or sets a value indicating whether this JSON result is camel cased on serialization.
  277. Default: true.
  278. </summary>
  279. </member>
  280. <member name="P:Abp.Web.Mvc.Controllers.Results.AbpJsonResult.Indented">
  281. <summary>
  282. Gets or sets a value indicating whether this JSON result uses <see cref="F:Newtonsoft.Json.Formatting.Indented"/> on serialization.
  283. Default: false.
  284. </summary>
  285. </member>
  286. <member name="M:Abp.Web.Mvc.Controllers.Results.AbpJsonResult.#ctor">
  287. <summary>
  288. Constructor.
  289. </summary>
  290. </member>
  291. <member name="M:Abp.Web.Mvc.Controllers.Results.AbpJsonResult.#ctor(System.Object)">
  292. <summary>
  293. Constructor with JSON data.
  294. </summary>
  295. <param name="data">JSON data</param>
  296. </member>
  297. <member name="M:Abp.Web.Mvc.Controllers.Results.AbpJsonResult.ExecuteResult(System.Web.Mvc.ControllerContext)">
  298. <inheritdoc/>
  299. </member>
  300. <member name="T:Abp.Web.Mvc.Controllers.WindsorControllerFactory">
  301. <summary>
  302. This class is used to allow MVC to use dependency injection system while creating MVC controllers.
  303. </summary>
  304. </member>
  305. <member name="F:Abp.Web.Mvc.Controllers.WindsorControllerFactory._iocManager">
  306. <summary>
  307. Reference to DI kernel.
  308. </summary>
  309. </member>
  310. <member name="M:Abp.Web.Mvc.Controllers.WindsorControllerFactory.#ctor(Abp.Dependency.IIocResolver)">
  311. <summary>
  312. Creates a new instance of WindsorControllerFactory.
  313. </summary>
  314. <param name="iocManager">Reference to DI kernel</param>
  315. </member>
  316. <member name="M:Abp.Web.Mvc.Controllers.WindsorControllerFactory.ReleaseController(System.Web.Mvc.IController)">
  317. <summary>
  318. Called by MVC system and releases/disposes given controller instance.
  319. </summary>
  320. <param name="controller">Controller instance</param>
  321. </member>
  322. <member name="M:Abp.Web.Mvc.Controllers.WindsorControllerFactory.GetControllerInstance(System.Web.Routing.RequestContext,System.Type)">
  323. <summary>
  324. Called by MVC system and creates controller instance for given controller type.
  325. </summary>
  326. <param name="requestContext">Request context</param>
  327. <param name="controllerType">Controller type</param>
  328. <returns></returns>
  329. </member>
  330. <member name="M:Abp.Web.Mvc.Extensions.HtmlHelperResourceExtensions.IncludeScript(System.Web.Mvc.HtmlHelper,System.String)">
  331. <summary>
  332. Includes a script to the page with versioning.
  333. </summary>
  334. <param name="html">Reference to the HtmlHelper object</param>
  335. <param name="url">URL of the script file</param>
  336. </member>
  337. <member name="M:Abp.Web.Mvc.Extensions.HtmlHelperResourceExtensions.IncludeStyle(System.Web.Mvc.HtmlHelper,System.String)">
  338. <summary>
  339. Includes a style to the page with versioning.
  340. </summary>
  341. <param name="html">Reference to the HtmlHelper object</param>
  342. <param name="url">URL of the style file</param>
  343. </member>
  344. <member name="T:Abp.Web.Mvc.Resources.WebResourceHelper">
  345. <summary>
  346. A helper class to simplify expose web resources.
  347. </summary>
  348. </member>
  349. <member name="M:Abp.Web.Mvc.Resources.WebResourceHelper.ExposeEmbeddedResources(System.String,System.Reflection.Assembly,System.String)">
  350. <summary>
  351. Exposes one or more embedded resources to web clients.
  352. It can be used to embed JavaScript/CSS files into assemblies and use them in html pages easily.
  353. </summary>
  354. <param name="rootPath">
  355. Root path of the resource. Can include '/' for deeper paths.
  356. </param>
  357. <param name="assembly">The assembly contains resources</param>
  358. <param name="resourceNamespace">Root namespace of the resources</param>
  359. </member>
  360. <member name="M:Abp.Web.Mvc.Resources.WebResourceHelper.GetEmbeddedResource(System.String)">
  361. <summary>
  362. Gets an embedded resource file.
  363. </summary>
  364. <param name="fullResourcePath">Full path of the resource</param>
  365. <returns>Embedded resource file</returns>
  366. </member>
  367. <member name="T:Abp.Web.Mvc.Views.AbpWebViewPage">
  368. <summary>
  369. Base class for all views in Abp system.
  370. </summary>
  371. </member>
  372. <member name="T:Abp.Web.Mvc.Views.AbpWebViewPage`1">
  373. <summary>
  374. Base class for all views in Abp system.
  375. </summary>
  376. <typeparam name="TModel">Type of the View Model</typeparam>
  377. </member>
  378. <member name="P:Abp.Web.Mvc.Views.AbpWebViewPage`1.ApplicationPath">
  379. <summary>
  380. Gets the root path of the application.
  381. </summary>
  382. </member>
  383. <member name="P:Abp.Web.Mvc.Views.AbpWebViewPage`1.SettingManager">
  384. <summary>
  385. Reference to the setting manager.
  386. </summary>
  387. </member>
  388. <member name="P:Abp.Web.Mvc.Views.AbpWebViewPage`1.LocalizationSourceName">
  389. <summary>
  390. Gets/sets name of the localization source that is used in this controller.
  391. It must be set in order to use <see cref="M:Abp.Web.Mvc.Views.AbpWebViewPage`1.L(System.String)"/> and <see cref="M:Abp.Web.Mvc.Views.AbpWebViewPage`1.L(System.String,System.Globalization.CultureInfo)"/> methods.
  392. </summary>
  393. </member>
  394. <member name="M:Abp.Web.Mvc.Views.AbpWebViewPage`1.#ctor">
  395. <summary>
  396. Constructor.
  397. </summary>
  398. </member>
  399. <member name="M:Abp.Web.Mvc.Views.AbpWebViewPage`1.L(System.String)">
  400. <summary>
  401. Gets localized string for given key name and current language.
  402. </summary>
  403. <param name="name">Key name</param>
  404. <returns>Localized string</returns>
  405. </member>
  406. <member name="M:Abp.Web.Mvc.Views.AbpWebViewPage`1.L(System.String,System.Object[])">
  407. <summary>
  408. Gets localized string for given key name and current language with formatting strings.
  409. </summary>
  410. <param name="name">Key name</param>
  411. <param name="args">Format arguments</param>
  412. <returns>Localized string</returns>
  413. </member>
  414. <member name="M:Abp.Web.Mvc.Views.AbpWebViewPage`1.L(System.String,System.Globalization.CultureInfo)">
  415. <summary>
  416. Gets localized string for given key name and specified culture information.
  417. </summary>
  418. <param name="name">Key name</param>
  419. <param name="culture">culture information</param>
  420. <returns>Localized string</returns>
  421. </member>
  422. <member name="M:Abp.Web.Mvc.Views.AbpWebViewPage`1.L(System.String,System.Globalization.CultureInfo,System.Object[])">
  423. <summary>
  424. Gets localized string for given key name and current language with formatting strings.
  425. </summary>
  426. <param name="name">Key name</param>
  427. <param name="culture">culture information</param>
  428. <param name="args">Format arguments</param>
  429. <returns>Localized string</returns>
  430. </member>
  431. <member name="M:Abp.Web.Mvc.Views.AbpWebViewPage`1.Ls(System.String,System.String)">
  432. <summary>
  433. Gets localized string from given source for given key name and current language.
  434. </summary>
  435. <param name="sourceName">Source name</param>
  436. <param name="name">Key name</param>
  437. <returns>Localized string</returns>
  438. </member>
  439. <member name="M:Abp.Web.Mvc.Views.AbpWebViewPage`1.Ls(System.String,System.String,System.Object[])">
  440. <summary>
  441. Gets localized string from given source for given key name and current language with formatting strings.
  442. </summary>
  443. <param name="sourceName">Source name</param>
  444. <param name="name">Key name</param>
  445. <param name="args">Format arguments</param>
  446. <returns>Localized string</returns>
  447. </member>
  448. <member name="M:Abp.Web.Mvc.Views.AbpWebViewPage`1.Ls(System.String,System.String,System.Globalization.CultureInfo)">
  449. <summary>
  450. Gets localized string from given source for given key name and specified culture information.
  451. </summary>
  452. <param name="sourceName">Source name</param>
  453. <param name="name">Key name</param>
  454. <param name="culture">culture information</param>
  455. <returns>Localized string</returns>
  456. </member>
  457. <member name="M:Abp.Web.Mvc.Views.AbpWebViewPage`1.Ls(System.String,System.String,System.Globalization.CultureInfo,System.Object[])">
  458. <summary>
  459. Gets localized string from given source for given key name and current language with formatting strings.
  460. </summary>
  461. <param name="sourceName">Source name</param>
  462. <param name="name">Key name</param>
  463. <param name="culture">culture information</param>
  464. <param name="args">Format arguments</param>
  465. <returns>Localized string</returns>
  466. </member>
  467. <member name="M:Abp.Web.Mvc.Views.AbpWebViewPage`1.IsGranted(System.String)">
  468. <summary>
  469. Checks if current user is granted for a permission.
  470. </summary>
  471. <param name="permissionName">Name of the permission</param>
  472. </member>
  473. <member name="M:Abp.Web.Mvc.Views.AbpWebViewPage`1.IsFeatureEnabled(System.String)">
  474. <summary>
  475. Determines whether is given feature enabled.
  476. </summary>
  477. <param name="featureName">Name of the feature.</param>
  478. <returns>True, if enabled; False if not.</returns>
  479. </member>
  480. <member name="M:Abp.Web.Mvc.Views.AbpWebViewPage`1.GetFeatureValue(System.String)">
  481. <summary>
  482. Gets current value of a feature.
  483. </summary>
  484. <param name="featureName">Feature name</param>
  485. <returns>Value of the feature</returns>
  486. </member>
  487. </members>
  488. </doc>