Added custom route name option

martijnboland · Feb 7, 2018 · 8819a79 · 8819a79
1 parent a6fd662
commit 8819a79
Show file tree

Hide file tree

Showing 7 changed files with 84 additions and 4 deletions.
diff --git a/src/MvcPaging.Demo/Controllers/PagingController.cs b/src/MvcPaging.Demo/Controllers/PagingController.cs
@@ -95,5 +95,13 @@ public ActionResult Bootstrap3(int? page)
             int currentPageIndex = page.HasValue ? page.Value - 1 : 0;
             return View(this.allProducts.ToPagedList(currentPageIndex, DefaultPageSize));
         }
+
+        [Route("genericos", Order = 3, Name = "genericos")]
+        [Route("generic", Order = 4, Name = "generic")]
+        public ActionResult CustomRouteName(int? page)
+        {
+            int currentPageIndex = page.HasValue ? page.Value - 1 : 0;
+            return View(this.allProducts.ToPagedList(currentPageIndex, DefaultPageSize));
+        }
     }
 }
diff --git a/src/MvcPaging.Demo/Global.asax.cs b/src/MvcPaging.Demo/Global.asax.cs
@@ -10,6 +10,8 @@ public static void RegisterRoutes(RouteCollection routes)
             routes.IgnoreRoute("{resource}.axd/{*pathInfo}");
             AreaRegistration.RegisterAllAreas();
 
+            routes.MapMvcAttributeRoutes();
+
             routes.MapRoute("SimplePaging", "SimplePaging/{page}",
                 new { controller = "Paging", action = "Index", page = UrlParameter.Optional },
                 new[] { "MvcPaging.Demo.Controllers" });

diff --git a/src/MvcPaging.Demo/MvcPaging.Demo.csproj b/src/MvcPaging.Demo/MvcPaging.Demo.csproj
@@ -19,7 +19,7 @@
     <UpgradeBackupLocation>
     </UpgradeBackupLocation>
     <TargetFrameworkProfile />
-    <UseIISExpress>false</UseIISExpress>
+    <UseIISExpress>true</UseIISExpress>
     <SolutionDir Condition="$(SolutionDir) == '' Or $(SolutionDir) == '*Undefined*'">..\..\</SolutionDir>
     <RestorePackages>true</RestorePackages>
     <IISExpressSSLPort />
@@ -28,6 +28,7 @@
     <IISExpressUseClassicPipelineMode>false</IISExpressUseClassicPipelineMode>
     <MvcProjectUpgradeChecked>true</MvcProjectUpgradeChecked>
     <UseGlobalApplicationHostFile />
+    <Use64BitIISExpress />
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
     <DebugSymbols>true</DebugSymbols>
@@ -197,6 +198,7 @@
     <Content Include="Views\Shared\ViewSource.cshtml" />
     <Content Include="Scripts\jquery-3.1.1.slim.min.map" />
     <Content Include="Scripts\jquery-3.1.1.min.map" />
+    <Content Include="Views\Paging\CustomRouteName.cshtml" />
   </ItemGroup>
   <ItemGroup>
     <ProjectReference Include="..\MvcPaging\MvcPaging.csproj">
@@ -244,11 +246,11 @@
     <VisualStudio>
       <FlavorProperties GUID="{349c5851-65df-11da-9384-00065b846f21}">
         <WebProjectProperties>
-          <UseIIS>False</UseIIS>
+          <UseIIS>True</UseIIS>
           <AutoAssignPort>True</AutoAssignPort>
           <DevelopmentServerPort>49800</DevelopmentServerPort>
           <DevelopmentServerVPath>/</DevelopmentServerVPath>
-          <IISUrl>http://localhost/MvcPaging</IISUrl>
+          <IISUrl>http://localhost:49801/</IISUrl>
           <NTLMAuthentication>False</NTLMAuthentication>
           <UseCustomServer>False</UseCustomServer>
           <CustomServerUrl>

diff --git a/src/MvcPaging.Demo/Views/Paging/CustomRouteName.cshtml b/src/MvcPaging.Demo/Views/Paging/CustomRouteName.cshtml
@@ -0,0 +1,35 @@
+@using MvcPaging.Demo.Models
+@model IPagedList<MvcPaging.Demo.Models.Product>
+@{
+    ViewBag.Title = "Browse all products";
+}
+<h2>@ViewBag.Title</h2>
+<table class="grid">
+    <thead>
+    <tr>
+        <th>Product name</th>
+        <th>Category</th>
+    </tr>
+    </thead>
+    <tbody>
+    @foreach (var product in Model)
+    {
+        <tr>
+            <td>@product.Name</td>
+            <td>@product.Category</td>
+        </tr>}
+    </tbody>
+</table>
+<div class="pager">
+    @Html.Pager(Model.PageSize, Model.PageNumber, Model.TotalItemCount).Options(o => o.CustomRouteName("generic"))
+</div>
+
+@{
+    var sourceModel = new ViewSourceViewModel();
+    sourceModel.RazorCode = @"
+";
+    sourceModel.ControllerCode = @"
+";
+}
+
+@Html.Partial("ViewSource", sourceModel)
diff --git a/src/MvcPaging/Pager.cs b/src/MvcPaging/Pager.cs
@@ -234,7 +234,8 @@ protected virtual string GeneratePageUrl(int pageNumber)
             pageLinkValueDictionary = pageLinkValueDictionary.FixListRouteDataValues();
 
             // 'Render' virtual path.
-            var virtualPathForArea = RouteTable.Routes.GetVirtualPathForArea(viewContext.RequestContext, pageLinkValueDictionary);
+            var virtualPathForArea = RouteTable.Routes.GetVirtualPathForArea(viewContext.RequestContext,
+                this.pagerOptions.CustomRouteName, pageLinkValueDictionary);
 
             return virtualPathForArea == null ? null : virtualPathForArea.VirtualPath;
         }

diff --git a/src/MvcPaging/PagerOptions.cs b/src/MvcPaging/PagerOptions.cs
@@ -23,6 +23,7 @@ public static class DefaultDefaults
             public const bool DisplayLastPage = false;
             public const bool UseItemCountAsPageCount = false;
             public static bool HidePreviousAndNextPage = false;
+            public const string CustomRouteName = null;
         }
 
         /// <summary>
@@ -46,6 +47,7 @@ public static class Defaults
             public static bool DisplayFirstPage = DefaultDefaults.DisplayFirstPage;
             public static bool DisplayLastPage = DefaultDefaults.DisplayLastPage;
             public static bool UseItemCountAsPageCount = DefaultDefaults.UseItemCountAsPageCount;
+            public static string CustomRouteName = DefaultDefaults.CustomRouteName;
 
             public static void Reset()
             {
@@ -64,6 +66,7 @@ public static void Reset()
                 DisplayFirstPage = DefaultDefaults.DisplayFirstPage;
                 DisplayLastPage = DefaultDefaults.DisplayLastPage;
                 UseItemCountAsPageCount = DefaultDefaults.UseItemCountAsPageCount;
+                CustomRouteName = DefaultDefaults.CustomRouteName;
             }
         }
 
@@ -107,6 +110,8 @@ public static void Reset()
 
         public bool UseItemCountAsPageCount { get; internal set; }
 
+        public string CustomRouteName { get; set; }
+
         public PagerOptions()
         {
             RouteValues = new RouteValueDictionary();
@@ -126,6 +131,7 @@ public PagerOptions()
             DisplayLastPage = DefaultDefaults.DisplayLastPage;
             UseItemCountAsPageCount = DefaultDefaults.UseItemCountAsPageCount;
             HidePreviousAndNextPage = DefaultDefaults.HidePreviousAndNextPage;
+            CustomRouteName = DefaultDefaults.CustomRouteName;
         }
     }
 }
diff --git a/src/MvcPaging/PagerOptionsBuilder.cs b/src/MvcPaging/PagerOptionsBuilder.cs
@@ -298,6 +298,21 @@ public PagerOptionsBuilder UseItemCountAsPageCount()
             return this;
         }
 
+        /// <summary>
+        /// Use an explicit route instead of letting ASP.NET MVC figuring out the correct route.
+        /// </summary>
+        /// <param name="customRouteName"></param>
+        /// <returns></returns>
+        public PagerOptionsBuilder CustomRouteName(string customRouteName)
+        {
+            if (customRouteName == null)
+            {
+                throw new ArgumentException("customRouteName may not be null", "customRouteName");
+            }
+            this.pagerOptions.CustomRouteName = customRouteName;
+            return this;
+        }
+
         /// <summary>
         /// Set the AjaxOptions.
         /// </summary>
@@ -558,5 +573,16 @@ public new PagerOptionsBuilder<TModel> UseItemCountAsPageCount()
             base.UseItemCountAsPageCount();
             return this;
         }
+
+        /// <summary>
+        /// Use an explicit route instead of letting ASP.NET MVC figuring out the correct route.
+        /// </summary>
+        /// <param name="customRouteName"></param>
+        /// <returns></returns>
+        public new PagerOptionsBuilder<TModel> CustomRouteName(string customRouteName)
+        {
+            base.CustomRouteName(customRouteName);
+            return this;
+        }
     }
 }