You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

205 lines
16 KiB

4 years ago
  1. <?xml version="1.0" encoding="utf-8"?>
  2. <doc>
  3. <assembly>
  4. <name>Microsoft.AspNet.FriendlyUrls</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Microsoft.AspNet.FriendlyUrls.FriendlyUrl"></member>
  8. <member name="M:Microsoft.AspNet.FriendlyUrls.FriendlyUrl.Href(System.String,System.Object[])"></member>
  9. <member name="M:Microsoft.AspNet.FriendlyUrls.FriendlyUrl.Resolve(System.String)">
  10. <summary> Resolves a file handler virtual path to a friendly URL using the registered resolvers. </summary>
  11. <returns>The friendly URL.</returns>
  12. <param name="virtualPath">The handler virtual path.</param>
  13. </member>
  14. <member name="P:Microsoft.AspNet.FriendlyUrls.FriendlyUrl.Segments">
  15. <summary> The URL segments left over after Friendly URLs mapped this request to a file. </summary>
  16. </member>
  17. <member name="T:Microsoft.AspNet.FriendlyUrls.FriendlyUrlSettings">
  18. <summary>Represents the settings used when enabling Friendly URLs.</summary>
  19. </member>
  20. <member name="M:Microsoft.AspNet.FriendlyUrls.FriendlyUrlSettings.#ctor">
  21. <summary>Creates a new instance of the FriendlyUrlSettings class with the default values.</summary>
  22. </member>
  23. <member name="P:Microsoft.AspNet.FriendlyUrls.FriendlyUrlSettings.AutoRedirectMode">
  24. <summary>The type of redirect to perform on non-friendly URLs to friendly URLs. Defaults to Off.</summary>
  25. <returns>Returns <see cref="T:Microsoft.AspNet.FriendlyUrls.RedirectMode" />.</returns>
  26. </member>
  27. <member name="P:Microsoft.AspNet.FriendlyUrls.FriendlyUrlSettings.ResolverCachingMode">
  28. <summary>The mode of caching to use when resolving friendly URLs. Defaults to ResolverCachingMode.Static.</summary>
  29. <returns>Returns <see cref="T:Microsoft.AspNet.FriendlyUrls.ResolverCachingMode" />.</returns>
  30. </member>
  31. <member name="P:Microsoft.AspNet.FriendlyUrls.FriendlyUrlSettings.SwitchViewRouteName">
  32. <summary>The name of the route that handles user requests to switch views. Defaults to "AspNet.FriendlyUrls.SwitchView".</summary>
  33. <returns>Returns <see cref="T:System.String" />.</returns>
  34. </member>
  35. <member name="P:Microsoft.AspNet.FriendlyUrls.FriendlyUrlSettings.SwitchViewUrl">
  36. <summary>The URL that view switching request are sent to. Defaults to "__FriendlyUrls_SwitchView/{view}".</summary>
  37. <returns>Returns <see cref="T:System.String" />.</returns>
  38. </member>
  39. <member name="T:Microsoft.AspNet.FriendlyUrls.HttpRequestExtensions"></member>
  40. <member name="M:Microsoft.AspNet.FriendlyUrls.HttpRequestExtensions.GetFriendlyUrlFileExtension(System.Web.HttpRequest)">
  41. <summary> Returns the extension of the file Friendly URLs mapped this request to. </summary>
  42. <returns>The file extension, e.g. .aspx.</returns>
  43. <param name="httpRequest">The HttpRequest object.</param>
  44. </member>
  45. <member name="M:Microsoft.AspNet.FriendlyUrls.HttpRequestExtensions.GetFriendlyUrlFileExtension(System.Web.HttpRequestBase)">
  46. <summary> Returns the extension of the file Friendly URLs mapped this request to. </summary>
  47. <returns>The file extension, e.g. .aspx.</returns>
  48. <param name="httpRequest">The HttpRequestBase object.</param>
  49. </member>
  50. <member name="M:Microsoft.AspNet.FriendlyUrls.HttpRequestExtensions.GetFriendlyUrlFileVirtualPath(System.Web.HttpRequest)">
  51. <summary> Returns the virtual path of the file Friendly URLs mapped this request to. </summary>
  52. <returns>The file virtual path</returns>
  53. <param name="httpRequest">The HttpRequest object.</param>
  54. </member>
  55. <member name="M:Microsoft.AspNet.FriendlyUrls.HttpRequestExtensions.GetFriendlyUrlFileVirtualPath(System.Web.HttpRequestBase)">
  56. <summary> Returns the virtual path of the file Friendly URLs mapped this request to. </summary>
  57. <returns>The file virtual path.</returns>
  58. <param name="httpRequest">The HttpRequestBase object.</param>
  59. </member>
  60. <member name="M:Microsoft.AspNet.FriendlyUrls.HttpRequestExtensions.GetFriendlyUrlSegments(System.Web.HttpRequest)">
  61. <summary> Returns the URL segments left over after Friendly URLs mapped this request to a file. </summary>
  62. <returns>The URL segments.</returns>
  63. <param name="httpRequest">The HttpRequest object.</param>
  64. </member>
  65. <member name="M:Microsoft.AspNet.FriendlyUrls.HttpRequestExtensions.GetFriendlyUrlSegments(System.Web.HttpRequestBase)">
  66. <summary>Returns the URL segments left over after the current request has been mapped to a file.</summary>
  67. <returns>The URL segments.</returns>
  68. <param name="httpRequest">The HttpRequestBase object.</param>
  69. </member>
  70. <member name="T:Microsoft.AspNet.FriendlyUrls.PreApplicationStartCode"></member>
  71. <member name="M:Microsoft.AspNet.FriendlyUrls.PreApplicationStartCode.Start"></member>
  72. <member name="T:Microsoft.AspNet.FriendlyUrls.RedirectMode">
  73. <summary>Represents the mode of redirect to use when auto-redirecting to friendly URLs.</summary>
  74. </member>
  75. <member name="F:Microsoft.AspNet.FriendlyUrls.RedirectMode.Permanent">
  76. <summary>Performs a permanent redirect (301 response code).</summary>
  77. </member>
  78. <member name="F:Microsoft.AspNet.FriendlyUrls.RedirectMode.Temporary">
  79. <summary>Performs a temporary redirect (302 response code).</summary>
  80. </member>
  81. <member name="F:Microsoft.AspNet.FriendlyUrls.RedirectMode.Off">
  82. <summary>Performs no auto-redirect (disabled).</summary>
  83. </member>
  84. <member name="T:Microsoft.AspNet.FriendlyUrls.ResolverCachingMode">
  85. <summary>Represents the mode of caching to use when resolving URLs. This setting affects how quickly extension-less URLs can be mapped back to their corresponding full URLs.</summary>
  86. </member>
  87. <member name="F:Microsoft.AspNet.FriendlyUrls.ResolverCachingMode.Static">
  88. <summary>Build a list of files at application startup. This mode of operation is appropriate for sites where files are not added or removed at runtime.</summary>
  89. </member>
  90. <member name="F:Microsoft.AspNet.FriendlyUrls.ResolverCachingMode.Dynamic">
  91. <summary>Builds a list of files as requests arrive, and updates the file list as files in the site change. This mode of operation uses more memory than a static cache, but is useful for updating the file list for sites where files or directories are added or removed at runtime.</summary>
  92. </member>
  93. <member name="F:Microsoft.AspNet.FriendlyUrls.ResolverCachingMode.Disabled">
  94. <summary>Don't perform any caching. Always query the file system directly every time a request to a friendly URL comes in.</summary>
  95. </member>
  96. <member name="T:Microsoft.AspNet.FriendlyUrls.RouteCollectionExtensions"></member>
  97. <member name="M:Microsoft.AspNet.FriendlyUrls.RouteCollectionExtensions.EnableFriendlyUrls(System.Web.Routing.RouteCollection)">
  98. <summary> Enables friendly URLs for Web Forms pages. </summary>
  99. <param name="routes">The routes collection.</param>
  100. </member>
  101. <member name="M:Microsoft.AspNet.FriendlyUrls.RouteCollectionExtensions.EnableFriendlyUrls(System.Web.Routing.RouteCollection,Microsoft.AspNet.FriendlyUrls.FriendlyUrlSettings)">
  102. <summary>Enables friendly URLs for Web Forms pages.</summary>
  103. <param name="routes">The routes collection.</param>
  104. <param name="settings">The settings to use when enabling Friendly Urls.</param>
  105. </member>
  106. <member name="M:Microsoft.AspNet.FriendlyUrls.RouteCollectionExtensions.EnableFriendlyUrls(System.Web.Routing.RouteCollection,Microsoft.AspNet.FriendlyUrls.FriendlyUrlSettings,Microsoft.AspNet.FriendlyUrls.Resolvers.IFriendlyUrlResolver[])">
  107. <summary> Enables friendly URLs using the passed resolvers. </summary>
  108. <param name="routes">The routes collection.</param>
  109. <param name="settings">The settings to use when enabling Friendly Urls.</param>
  110. <param name="resolvers">The friendly URL resolvers to use.</param>
  111. </member>
  112. <member name="M:Microsoft.AspNet.FriendlyUrls.RouteCollectionExtensions.EnableFriendlyUrls(System.Web.Routing.RouteCollection,Microsoft.AspNet.FriendlyUrls.Resolvers.IFriendlyUrlResolver[])">
  113. <summary> Enables friendly URLs using the specified resolvers. </summary>
  114. <param name="routes">The routes collection.</param>
  115. <param name="resolvers">The friendly URL resolvers to use.</param>
  116. </member>
  117. <member name="T:Microsoft.AspNet.FriendlyUrls.ModelBinding.FriendlyUrlSegmentsAttribute">
  118. <summary>Represents an attribute that specifies that model binding values are provided by a friendly URL segment.</summary>
  119. </member>
  120. <member name="M:Microsoft.AspNet.FriendlyUrls.ModelBinding.FriendlyUrlSegmentsAttribute.#ctor(System.Int32)">
  121. <summary> Creates an instance of the FriendlyUrlSegmentsAttribute class.</summary>
  122. <param name="index">The index of the URL segment to return.</param>
  123. </member>
  124. <member name="M:Microsoft.AspNet.FriendlyUrls.ModelBinding.FriendlyUrlSegmentsAttribute.GetValueProvider(System.Web.ModelBinding.ModelBindingExecutionContext)">
  125. <returns>Returns <see cref="T:System.Web.ModelBinding.IValueProvider" />.</returns>
  126. </member>
  127. <member name="T:Microsoft.AspNet.FriendlyUrls.ModelBinding.FriendlyUrlSegmentsValueProvider">
  128. <summary> A value provider that retrieves values from the segments of a Friendly URL.</summary>
  129. </member>
  130. <member name="M:Microsoft.AspNet.FriendlyUrls.ModelBinding.FriendlyUrlSegmentsValueProvider.#ctor(System.Web.ModelBinding.ModelBindingExecutionContext,System.Int32)"></member>
  131. <member name="M:Microsoft.AspNet.FriendlyUrls.ModelBinding.FriendlyUrlSegmentsValueProvider.FetchValue(System.String)">
  132. <returns>Returns <see cref="T:System.Object" />.</returns>
  133. </member>
  134. <member name="T:Microsoft.AspNet.FriendlyUrls.Resolvers.FriendlyUrlResolver">
  135. <summary>Resolves a friendly URL to an HTTP handler.</summary>
  136. </member>
  137. <member name="M:Microsoft.AspNet.FriendlyUrls.Resolvers.FriendlyUrlResolver.#ctor(System.String)">
  138. <summary>Creates a FriendlyUrlResolver for the provided extension.</summary>
  139. <param name="fileExtension">The physical file extension understood by this resolver. Must include the leading period, e.g. ".aspx".</param>
  140. </member>
  141. <member name="M:Microsoft.AspNet.FriendlyUrls.Resolvers.FriendlyUrlResolver.ConvertToFriendlyUrl(System.String)">
  142. <summary>Converts a typical URL with a file extension into a friendly extension-less URL.</summary>
  143. <returns>The friendly URL (extension stripped) if this resolver can automatically map extensionless URLs to physical files with the provided extension. Otherwise, null.</returns>
  144. <param name="path">The original path, including the file extension.</param>
  145. </member>
  146. <member name="M:Microsoft.AspNet.FriendlyUrls.Resolvers.FriendlyUrlResolver.GetExtensions(System.Web.HttpContextBase)">
  147. <summary>Gets the extensions to use (such as .aspx, .ashx, or .mobile.aspx) while attempting to resolve an HTTP handler from the friendly URL.</summary>
  148. <returns>The list of extensions.</returns>
  149. <param name="httpContext">The current HttpContext.</param>
  150. </member>
  151. <member name="M:Microsoft.AspNet.FriendlyUrls.Resolvers.FriendlyUrlResolver.PreprocessRequest(System.Web.HttpContextBase,System.Web.IHttpHandler)">
  152. <summary>Called after a friendly URL is resolved to an HTTP handler but before the handler is executed.</summary>
  153. <param name="httpContext">The current HttpContext.</param>
  154. <param name="httpHandler">The HTTP handler.</param>
  155. </member>
  156. <member name="T:Microsoft.AspNet.FriendlyUrls.Resolvers.GenericHandlerFriendlyUrlResolver">
  157. <summary>Resolves friendly URLs to generic handlers such as *.ashx.</summary>
  158. </member>
  159. <member name="M:Microsoft.AspNet.FriendlyUrls.Resolvers.GenericHandlerFriendlyUrlResolver.#ctor"></member>
  160. <member name="T:Microsoft.AspNet.FriendlyUrls.Resolvers.IFriendlyUrlResolver"></member>
  161. <member name="M:Microsoft.AspNet.FriendlyUrls.Resolvers.IFriendlyUrlResolver.ConvertToFriendlyUrl(System.String)">
  162. <summary>Converts a typical URL with a file extension into a friendly extension-less URL.</summary>
  163. <returns>The friendly extension-less URL if this resolver can automaticallymap extensionless URLs to physical files with the provided extension. Otherwise, null.</returns>
  164. <param name="path">The original path, including the file extension.</param>
  165. </member>
  166. <member name="M:Microsoft.AspNet.FriendlyUrls.Resolvers.IFriendlyUrlResolver.GetExtensions(System.Web.HttpContextBase)">
  167. <summary>Returns a list of file extensions that the Friendly URLs system will try to resolve for the current request. For example, if the current request is for "~/example" and the GetExtensions method returns [ ".mobile.aspx", ".aspx", ".en-us.aspx" ], then the Friendly URLs system will attempt to match the current request to thefiles "~/example.mobile.aspx", "~/example.aspx", and "~/example.en-us.aspx", returning the first match.</summary>
  168. <returns>A list of extensions that the system should try to resolve.</returns>
  169. <param name="httpContext">The current request.</param>
  170. </member>
  171. <member name="M:Microsoft.AspNet.FriendlyUrls.Resolvers.IFriendlyUrlResolver.PreprocessRequest(System.Web.HttpContextBase,System.Web.IHttpHandler)">
  172. <summary>Provides the ability to inspect or modify the IHttpHandler that was resolved for the current request before the handler's ProcessRequest method is called.</summary>
  173. <param name="httpContext">Information about the current request.</param>
  174. <param name="httpHandler">The handler that will be invoked.</param>
  175. </member>
  176. <member name="T:Microsoft.AspNet.FriendlyUrls.Resolvers.WebFormsFriendlyUrlResolver">
  177. <summary>Resolves friendly URLs to Web Forms pages.</summary>
  178. </member>
  179. <member name="M:Microsoft.AspNet.FriendlyUrls.Resolvers.WebFormsFriendlyUrlResolver.#ctor"></member>
  180. <member name="M:Microsoft.AspNet.FriendlyUrls.Resolvers.WebFormsFriendlyUrlResolver.GetExtensions(System.Web.HttpContextBase)">
  181. <returns>Returns <see cref="T:System.Collections.Generic.IList`1" />.</returns>
  182. </member>
  183. <member name="M:Microsoft.AspNet.FriendlyUrls.Resolvers.WebFormsFriendlyUrlResolver.IsMobileExtension(System.Web.HttpContextBase,System.String)">
  184. <returns>Returns <see cref="T:System.Boolean" />.</returns>
  185. </member>
  186. <member name="M:Microsoft.AspNet.FriendlyUrls.Resolvers.WebFormsFriendlyUrlResolver.IsMobileView(System.Web.HttpContextBase)">
  187. <summary>Determines if the current friendly URL was resolved to a mobile view based on the client browser and/or overrides.</summary>
  188. <returns>Whether the current view is a mobile view.</returns>
  189. <param name="httpContext">The page.</param>
  190. </member>
  191. <member name="M:Microsoft.AspNet.FriendlyUrls.Resolvers.WebFormsFriendlyUrlResolver.PreprocessRequest(System.Web.HttpContextBase,System.Web.IHttpHandler)"></member>
  192. <member name="M:Microsoft.AspNet.FriendlyUrls.Resolvers.WebFormsFriendlyUrlResolver.TrySetMasterPageFile(System.Web.UI.Page,System.String)">
  193. <summary>Attempts to set the MasterPageFile property for the given page based on whether the master page exists.</summary>
  194. <returns>A boolean value indicating whether the master page was set.</returns>
  195. <param name="page">The page.</param>
  196. <param name="masterPageFile">The master page file virtual path.</param>
  197. </member>
  198. <member name="M:Microsoft.AspNet.FriendlyUrls.Resolvers.WebFormsFriendlyUrlResolver.TrySetMobileMasterPage(System.Web.HttpContextBase,System.Web.UI.Page,System.String)">
  199. <summary>Attempts to set the MasterPageFile property for the given page to a mobile specific master page.</summary>
  200. <returns>A boolean value indicating whether the master page was set.</returns>
  201. <param name="httpContext">The HTTP context.</param>
  202. <param name="page">The page.</param>
  203. </member>
  204. <member name="F:Microsoft.AspNet.FriendlyUrls.Resolvers.WebFormsFriendlyUrlResolver.ViewSwitcherCookieName"></member>
  205. </members>
  206. </doc>