public override void RegisterGrids()
{
MVCGridDefinitionTable.Add("ContainerGrid", new MVCGridBuilder<Person>()
.AddColumns(cols =>
{
cols.Add("Id").WithValueExpression((p, c) => p.Id.ToString());
cols.Add("FirstName").WithHeaderText("First Name")
.WithValueExpression((p, c) => p.FirstName);
cols.Add("LastName").WithHeaderText("Last Name")
.WithValueExpression((p, c) => p.LastName);
})
.WithRenderingMode(RenderingMode.Controller)
.WithViewPath("~/Views/MVCGrid/_Grid.cshtml")
.WithContainerViewPath("~/Views/MVCGrid/_Container.cshtml")
.WithRetrieveDataMethod((options) =>
{
var result = new QueryResult<Person>();
using (var db = new SampleDatabaseEntities())
{
result.Items = db.People.Where(p => p.Employee).ToList();
}
return result;
})
);
}
public static void RegisterGrids()
{
ColumnDefaults colDefauls = new ColumnDefaults()
{
EnableSorting = true
};
MVCGridDefinitionTable.Add("TestGrid", new MVCGridBuilder<Person>(colDefauls)
.WithAuthorizationType(AuthorizationType.AllowAnonymous)
.WithSorting(sorting: true, defaultSortColumn: "Id", defaultSortDirection: SortDirection.Dsc)
.WithPaging(paging: true, itemsPerPage: 10, allowChangePageSize: true, maxItemsPerPage: 100)
.WithAdditionalQueryOptionNames("search")
.AddColumns(cols =>
{
cols.Add("Id").WithValueExpression((p, c) => c.UrlHelper.Action("detail", "demo", new { id = p.Id }))
.WithValueTemplate("<a href='{Value}'>{Model.Id}</a>", false)
.WithPlainTextValueExpression(p => p.Id.ToString());
cols.Add("FirstName").WithHeaderText("First Name")
.WithVisibility(true, true)
.WithValueExpression(p => p.FirstName);
cols.Add("LastName").WithHeaderText("Last Name")
.WithVisibility(true, true)
.WithValueExpression(p => p.LastName);
cols.Add("FullName").WithHeaderText("Full Name")
.WithValueTemplate("{Model.FirstName} {Model.LastName}")
.WithVisibility(visible: false, allowChangeVisibility: true)
.WithSorting(false);
cols.Add("StartDate").WithHeaderText("Start Date")
.WithVisibility(visible: true, allowChangeVisibility: true)
.WithValueExpression(p => p.StartDate.HasValue ? p.StartDate.Value.ToShortDateString() : "");
cols.Add("Status")
.WithSortColumnData("Active")
.WithVisibility(visible: true, allowChangeVisibility: true)
.WithHeaderText("Status")
.WithValueExpression(p => p.Active ? "Active" : "Inactive")
.WithCellCssClassExpression(p => p.Active ? "success" : "danger");
cols.Add("Gender").WithValueExpression((p, c) => p.Gender)
.WithAllowChangeVisibility(true);
cols.Add("Email")
.WithVisibility(visible: false, allowChangeVisibility: true)
.WithValueExpression(p => p.Email);
cols.Add("Url").WithVisibility(false)
.WithValueExpression((p, c) => c.UrlHelper.Action("detail", "demo", new { id = p.Id }));
})
//.WithAdditionalSetting(MVCGrid.Rendering.BootstrapRenderingEngine.SettingNameTableClass, "notreal") // Example of changing table css class
.WithRetrieveDataMethod((context) =>
{
var options = context.QueryOptions;
int totalRecords;
var repo = DependencyResolver.Current.GetService<IPersonRepository>();
string globalSearch = options.GetAdditionalQueryOptionString("search");
string sortColumn = options.GetSortColumnData<string>();
var items = repo.GetData(out totalRecords, globalSearch, options.GetLimitOffset(), options.GetLimitRowcount(),
sortColumn, options.SortDirection == SortDirection.Dsc);
return new QueryResult<Person>()
{
Items = items,
TotalRecords = totalRecords
};
})
);
MVCGridDefinitionTable.Add("EmployeeGrid", new MVCGridBuilder<Person>()
.WithAuthorizationType(AuthorizationType.AllowAnonymous)
.AddColumns(cols =>
{
cols.Add("Id").WithValueExpression(p => p.Id.ToString());
cols.Add("FirstName").WithHeaderText("First Name")
.WithValueExpression(p => p.FirstName);
cols.Add("LastName").WithHeaderText("Last Name")
.WithValueExpression(p => p.LastName);
})
.WithRetrieveDataMethod((options) =>
{
var result = new QueryResult<Person>();
using (var db = new SampleDatabaseEntities())
{
result.Items = db.People.Where(p => p.Employee).ToList();
}
return result;
})
);
MVCGridDefinitionTable.Add("SortableGrid", new MVCGridBuilder<Person>(colDefauls)
.WithAuthorizationType(AuthorizationType.AllowAnonymous)
.AddColumns(cols =>
{
cols.Add("Id").WithSorting(false)
.WithValueExpression(p => p.Id.ToString());
cols.Add("FirstName").WithHeaderText("First Name")
.WithValueExpression(p => p.FirstName);
cols.Add("LastName").WithHeaderText("Last Name")
.WithValueExpression(p => p.LastName);
})
.WithSorting(true, "LastName")
.WithRetrieveDataMethod((context) =>
{
var options = context.QueryOptions;
var result = new QueryResult<Person>();
using (var db = new SampleDatabaseEntities())
{
var query = db.People.Where(p => p.Employee);
if (!String.IsNullOrWhiteSpace(options.SortColumnName))
{
switch (options.SortColumnName.ToLower())
{
case "firstname":
query = query.OrderBy(p => p.FirstName, options.SortDirection);
break;
case "lastname":
query = query.OrderBy(p => p.LastName, options.SortDirection);
break;
}
}
result.Items = query.ToList();
}
return result;
})
);
MVCGridDefinitionTable.Add("PagingGrid", new MVCGridBuilder<Person>(colDefauls)
.WithAuthorizationType(AuthorizationType.AllowAnonymous)
.AddColumns(cols =>
{
cols.Add("Id").WithSorting(false)
.WithValueExpression(p => p.Id.ToString());
cols.Add("FirstName").WithHeaderText("First Name")
.WithValueExpression(p => p.FirstName);
cols.Add("LastName").WithHeaderText("Last Name")
.WithValueExpression(p => p.LastName);
})
.WithSorting(true, "LastName")
.WithPaging(true, 10)
.WithRetrieveDataMethod((context) =>
{
var options = context.QueryOptions;
var result = new QueryResult<Person>();
using (var db = new SampleDatabaseEntities())
{
var query = db.People.AsQueryable();
result.TotalRecords = query.Count();
if (!String.IsNullOrWhiteSpace(options.SortColumnName))
{
switch (options.SortColumnName.ToLower())
{
case "firstname":
query = query.OrderBy(p => p.FirstName, options.SortDirection);
break;
case "lastname":
query = query.OrderBy(p => p.LastName, options.SortDirection);
break;
}
}
if (options.GetLimitOffset().HasValue)
{
query = query.Skip(options.GetLimitOffset().Value).Take(options.GetLimitRowcount().Value);
}
result.Items = query.ToList();
}
return result;
})
);
MVCGridDefinitionTable.Add("DIGrid", new MVCGridBuilder<Person>(colDefauls)
.WithAuthorizationType(AuthorizationType.AllowAnonymous)
.AddColumns(cols =>
{
cols.Add("Id").WithSorting(false)
.WithValueExpression(p => p.Id.ToString());
cols.Add("FirstName").WithHeaderText("First Name")
.WithValueExpression(p => p.FirstName);
cols.Add("LastName").WithHeaderText("Last Name")
.WithValueExpression(p => p.LastName);
})
.WithSorting(true, "LastName")
.WithPaging(true, 10)
.WithRetrieveDataMethod((context) =>
{
var options = context.QueryOptions;
int totalRecords;
var repo = DependencyResolver.Current.GetService<IPersonRepository>();
var items = repo.GetData(out totalRecords, options.GetLimitOffset(), options.GetLimitRowcount(),
options.SortColumnName, options.SortDirection == SortDirection.Dsc);
return new QueryResult<Person>()
{
Items = items,
TotalRecords = totalRecords
};
})
);
MVCGridDefinitionTable.Add("FormattingGrid", new MVCGridBuilder<Person>(colDefauls)
.WithAuthorizationType(AuthorizationType.AllowAnonymous)
.AddColumns(cols =>
{
cols.Add("Id").WithSorting(false)
.WithValueExpression(p => p.Id.ToString());
cols.Add("FirstName").WithHeaderText("First Name")
.WithValueExpression(p => p.FirstName);
cols.Add("LastName").WithHeaderText("Last Name")
.WithValueExpression(p => p.LastName);
cols.Add("StartDate").WithHeaderText("Start Date")
.WithValueExpression(p => p.StartDate.HasValue ? p.StartDate.Value.ToShortDateString() : "");
cols.Add("ViewLink").WithSorting(false)
.WithHeaderText("")
.WithHtmlEncoding(false)
.WithValueExpression((p, c) => c.UrlHelper.Action("detail", "demo", new { id = p.Id }))
.WithValueTemplate("<a href='{Value}'>View</a>");
})
.WithSorting(true, "LastName")
.WithPaging(true, 10)
.WithRetrieveDataMethod((context) =>
{
var options = context.QueryOptions;
int totalRecords;
var repo = DependencyResolver.Current.GetService<IPersonRepository>();
var items = repo.GetData(out totalRecords, options.GetLimitOffset(), options.GetLimitRowcount(),
options.SortColumnName, options.SortDirection == SortDirection.Dsc);
return new QueryResult<Person>()
{
Items = items,
TotalRecords = totalRecords
};
})
);
MVCGridDefinitionTable.Add("StyledGrid", new MVCGridBuilder<Person>(colDefauls)
.WithAuthorizationType(AuthorizationType.AllowAnonymous)
.AddColumns(cols =>
{
cols.Add("Id").WithSorting(false)
.WithValueExpression(p => p.Id.ToString());
cols.Add("FirstName").WithHeaderText("First Name")
.WithValueExpression(p => p.FirstName);
cols.Add("LastName").WithHeaderText("Last Name")
.WithValueExpression(p => p.LastName);
cols.Add("StartDate").WithHeaderText("Start Date")
.WithValueExpression(p => p.StartDate.HasValue ? p.StartDate.Value.ToShortDateString() : "");
cols.Add("Status").WithSortColumnData("Active")
.WithHeaderText("Status")
.WithValueExpression(p => p.Active ? "Active" : "Inactive");
cols.Add("Gender").WithValueExpression(p => p.Gender)
.WithCellCssClassExpression(p => p.Gender == "Female" ? "danger" : "warning");
cols.Add().WithColumnName("ViewLink")
.WithSorting(false)
.WithHeaderText("")
.WithHtmlEncoding(false)
.WithValueExpression((p, c) => c.UrlHelper.Action("detail", new { id = p.Id }))
.WithValueTemplate("<a href='{Value}'>View</a>");
})
.WithRowCssClassExpression(p => p.Active ? "success" : "")
.WithSorting(true, "LastName")
.WithPaging(true, 10)
.WithRetrieveDataMethod((context) =>
{
var options = context.QueryOptions;
int totalRecords;
var repo = DependencyResolver.Current.GetService<IPersonRepository>();
string sortColumn = options.GetSortColumnData<string>();
var items = repo.GetData(out totalRecords, options.GetLimitOffset(), options.GetLimitRowcount(),
sortColumn, options.SortDirection == SortDirection.Dsc);
return new QueryResult<Person>()
{
Items = items,
TotalRecords = totalRecords
};
})
);
MVCGridDefinitionTable.Add("Preloading", new MVCGridBuilder<Person>(colDefauls)
.WithAuthorizationType(AuthorizationType.AllowAnonymous)
.AddColumns(cols =>
{
cols.Add("Id").WithSorting(false)
.WithValueExpression(p => p.Id.ToString());
cols.Add("FirstName").WithHeaderText("First Name")
.WithValueExpression(p => p.FirstName);
cols.Add("LastName").WithHeaderText("Last Name")
.WithValueExpression(p => p.LastName);
})
.WithPreloadData(false)
.WithSorting(true, "LastName")
.WithPaging(true, 10)
.WithRetrieveDataMethod((context) =>
{
var options = context.QueryOptions;
int totalRecords;
var repo = DependencyResolver.Current.GetService<IPersonRepository>();
var items = repo.GetData(out totalRecords, options.GetLimitOffset(), options.GetLimitRowcount(),
options.GetSortColumnData<string>(), options.SortDirection == SortDirection.Dsc);
return new QueryResult<Person>()
{
Items = items,
TotalRecords = totalRecords
};
})
);
MVCGridDefinitionTable.Add("CustomLoading", new MVCGridBuilder<Person>(colDefauls)
.WithAuthorizationType(AuthorizationType.AllowAnonymous)
.AddColumns(cols =>
{
cols.Add("Id").WithSorting(false)
.WithValueExpression(p => p.Id.ToString());
cols.Add("FirstName")
.WithHeaderText("First Name")
.WithValueExpression(p => p.FirstName);
cols.Add("LastName").WithHeaderText("Last Name")
.WithValueExpression(p => p.LastName);
})
.WithSorting(true, "LastName")
.WithPaging(true, 10)
.WithClientSideLoadingMessageFunctionName("showLoading")
.WithClientSideLoadingCompleteFunctionName("hideLoading")
.WithRetrieveDataMethod((context) =>
{
var options = context.QueryOptions;
int totalRecords;
var repo = DependencyResolver.Current.GetService<IPersonRepository>();
var items = repo.GetData(out totalRecords, options.GetLimitOffset(), options.GetLimitRowcount(),
options.GetSortColumnData<string>(), options.SortDirection == SortDirection.Dsc);
// pause to test loading message
System.Threading.Thread.Sleep(1000);
return new QueryResult<Person>()
{
Items = items,
TotalRecords = totalRecords
};
})
);
MVCGridDefinitionTable.Add("Filtering", new MVCGridBuilder<Person>(colDefauls)
.WithAuthorizationType(AuthorizationType.AllowAnonymous)
.AddColumns(cols =>
{
cols.Add("Id").WithSorting(false)
.WithValueExpression(p => p.Id.ToString());
cols.Add("LastName").WithHeaderText("Last Name")
.WithValueExpression(p => p.LastName)
.WithFiltering(true);
cols.Add("FirstName").WithHeaderText("First Name")
.WithValueExpression(p => p.FirstName)
.WithFiltering(true);
cols.Add("Status").WithSortColumnData("Active")
.WithHeaderText("Status")
.WithValueExpression(p => p.Active ? "Active" : "Inactive")
.WithFiltering(true);
})
.WithSorting(true, "LastName")
.WithPaging(true, 10, true, 100)
.WithFiltering(true)
.WithRetrieveDataMethod((context) =>
{
var options = context.QueryOptions;
int totalRecords;
var repo = DependencyResolver.Current.GetService<IPersonRepository>();
bool? active = null;
string fa = options.GetFilterString("Status");
if (!String.IsNullOrWhiteSpace(fa))
{
active = (String.Compare(fa, "active", true) == 0);
}
string sortColumn = options.GetSortColumnData<string>();
var items = repo.GetData(out totalRecords,
options.GetFilterString("FirstName"),
options.GetFilterString("LastName"),
active,
options.GetLimitOffset(), options.GetLimitRowcount(),
sortColumn, options.SortDirection == SortDirection.Dsc);
return new QueryResult<Person>()
{
Items = items,
TotalRecords = totalRecords
};
})
);
MVCGridDefinitionTable.Add("ExportGrid", new MVCGridBuilder<Person>(colDefauls)
.WithAuthorizationType(AuthorizationType.AllowAnonymous)
.AddColumns(cols =>
{
cols.Add().WithColumnName("Id")
.WithSorting(false)
.WithHtmlEncoding(false)
.WithValueExpression((p, c) =>
{
return String.Format("<a href='{0}'>{1}</a>",
c.UrlHelper.Action("detail", "demo", new { id = p.Id }), p.Id);
})
.WithPlainTextValueExpression(p => p.Id.ToString());
cols.Add("FirstName").WithHeaderText("First Name")
.WithValueExpression(p => p.FirstName);
cols.Add("LastName").WithHeaderText("Last Name")
.WithValueExpression(p => p.LastName);
cols.Add("Status").WithSortColumnData("Active")
.WithHeaderText("Status")
.WithValueExpression(p => p.Active ? "Active" : "Inactive");
})
.WithSorting(true, "LastName")
.WithPaging(true, 10)
.WithClientSideLoadingMessageFunctionName("showLoading")
.WithClientSideLoadingCompleteFunctionName("hideLoading")
.WithRetrieveDataMethod((context) =>
{
var options = context.QueryOptions;
int totalRecords;
var repo = DependencyResolver.Current.GetService<IPersonRepository>();
string sortColumn = options.GetSortColumnData<string>();
var items = repo.GetData(out totalRecords,
options.GetLimitOffset(), options.GetLimitRowcount(),
sortColumn, options.SortDirection == SortDirection.Dsc);
return new QueryResult<Person>()
{
Items = items,
TotalRecords = totalRecords
};
})
);
MVCGridDefinitionTable.Add("Multiple1", new MVCGridBuilder<Person>(colDefauls)
.WithAuthorizationType(AuthorizationType.AllowAnonymous)
.AddColumns(cols =>
{
cols.Add("Id").WithSorting(false)
.WithHtmlEncoding(false)
.WithValueExpression((p, c) => c.UrlHelper.Action("detail", "demo", new { id = p.Id }))
.WithValueTemplate("<a href='{Value}'>{Model.Id}</a>")
.WithPlainTextValueExpression((p, c) => p.Id.ToString());
cols.Add("FirstName").WithHeaderText("First Name")
.WithValueExpression(p => p.FirstName);
cols.Add("LastName").WithHeaderText("Last Name")
.WithValueExpression(p => p.LastName);
cols.Add("Status").WithSortColumnData("Active")
.WithHeaderText("Status")
.WithValueExpression(p => p.Active ? "Active" : "Inactive");
})
.WithSorting(true, "LastName")
.WithPaging(true, 10)
.WithQueryStringPrefix("grid1")
.WithRetrieveDataMethod((context) =>
{
var options = context.QueryOptions;
int totalRecords;
var repo = DependencyResolver.Current.GetService<IPersonRepository>();
string sortColumn = options.GetSortColumnData<string>();
var items = repo.GetData(out totalRecords,
options.GetLimitOffset(), options.GetLimitRowcount(),
sortColumn, options.SortDirection == SortDirection.Dsc);
return new QueryResult<Person>()
{
Items = items,
TotalRecords = totalRecords
};
})
);
MVCGridDefinitionTable.Add("Multiple2", new MVCGridBuilder<TestItem>(colDefauls)
.WithAuthorizationType(AuthorizationType.AllowAnonymous)
.AddColumns(cols =>
{
cols.Add("Col1").WithValueExpression(p => p.Col1);
cols.Add("Col2").WithValueExpression(p => p.Col2);
cols.Add("Col3").WithValueExpression(p => p.Col3);
})
.WithSorting(true, "Col1")
.WithPaging(true, 10)
.WithQueryStringPrefix("grid2")
.WithRetrieveDataMethod((context) =>
{
var options = context.QueryOptions;
TestItemRepository repo = new TestItemRepository();
int totalRecords;
var items = repo.GetData(out totalRecords, options.GetLimitOffset(), options.GetLimitRowcount(), options.GetSortColumnData<string>(), options.SortDirection == SortDirection.Dsc);
return new QueryResult<TestItem>()
{
Items = items,
TotalRecords = totalRecords
};
})
);
MVCGridDefinitionTable.Add("CustomStyle", new MVCGridBuilder<Person>(colDefauls)
.WithAuthorizationType(AuthorizationType.AllowAnonymous)
.AddColumns(cols =>
{
cols.Add("Id").WithSorting(false)
.WithHtmlEncoding(false)
.WithValueExpression((p, c) => c.UrlHelper.Action("detail", "demo", new { id = p.Id }))
.WithValueTemplate("<a href='{Value}'>{Model.Id}</a>")
.WithPlainTextValueExpression(p => p.Id.ToString());
cols.Add("FirstName").WithHeaderText("First Name")
.WithValueExpression(p => p.FirstName);
cols.Add("LastName").WithHeaderText("Last Name")
.WithValueExpression(p => p.LastName);
cols.Add("Status").WithSortColumnData("Active")
.WithHeaderText("Status")
.WithValueExpression(p => p.Active ? "Active" : "Inactive");
})
.WithRenderingEngine(typeof(CustomHtmlRenderingEngine))
.WithSorting(true, "LastName")
.WithPaging(true, 20)
.WithRetrieveDataMethod((context) =>
{
var options = context.QueryOptions;
int totalRecords;
var repo = DependencyResolver.Current.GetService<IPersonRepository>();
string sortColumn = options.GetSortColumnData<string>();
var items = repo.GetData(out totalRecords,
options.GetLimitOffset(), options.GetLimitRowcount(),
sortColumn, options.SortDirection == SortDirection.Dsc);
return new QueryResult<Person>()
{
Items = items,
TotalRecords = totalRecords
};
})
);
MVCGridDefinitionTable.Add("CustomRazorView", new MVCGridBuilder<Person>(colDefauls)
.WithAuthorizationType(AuthorizationType.AllowAnonymous)
.WithRenderingMode(RenderingMode.Controller)
.WithViewPath("~/Views/MVCGrid/_Custom.cshtml")
.AddColumns(cols =>
{
cols.Add("Id").WithSorting(false)
.WithHtmlEncoding(false)
.WithValueExpression((p, c) => c.UrlHelper.Action("detail", "demo", new { id = p.Id }))
.WithValueTemplate("<a href='{Value}'>{Model.Id}</a>")
.WithPlainTextValueExpression(p => p.Id.ToString());
cols.Add("FirstName").WithHeaderText("First Name")
.WithValueExpression(p => p.FirstName);
cols.Add("LastName").WithHeaderText("Last Name")
.WithValueExpression(p => p.LastName);
cols.Add("Status").WithSortColumnData("Active")
.WithHeaderText("Status")
.WithValueExpression(p => p.Active ? "Active" : "Inactive");
})
.WithSorting(true, "LastName")
.WithPaging(true, 20)
.WithRetrieveDataMethod((context) =>
{
var options = context.QueryOptions;
int totalRecords;
var repo = DependencyResolver.Current.GetService<IPersonRepository>();
string sortColumn = options.GetSortColumnData<string>();
var items = repo.GetData(out totalRecords,
options.GetLimitOffset(), options.GetLimitRowcount(),
sortColumn, options.SortDirection == SortDirection.Dsc);
return new QueryResult<Person>()
{
Items = items,
TotalRecords = totalRecords
};
})
);
MVCGridDefinitionTable.Add("ValueTemplate", new MVCGridBuilder<Person>(colDefauls)
.WithAuthorizationType(AuthorizationType.AllowAnonymous)
.AddColumns(cols =>
{
cols.Add("Id").WithSorting(false)
.WithValueExpression((p, c) => c.UrlHelper.Action("detail", "demo", new { id = p.Id }))
.WithValueTemplate("<a href='{Value}'>{Model.Id}</a>", false)
.WithPlainTextValueExpression(p => p.Id.ToString());
cols.Add("FirstName").WithHeaderText("First Name")
.WithValueExpression(p => p.FirstName);
cols.Add("LastName").WithHeaderText("Last Name")
.WithValueExpression(p => p.LastName);
cols.Add("Edit").WithHtmlEncoding(false)
.WithSorting(false)
.WithHeaderText(" ")
.WithValueExpression((p, c) => c.UrlHelper.Action("detail", "demo", new { id = p.Id }))
.WithValueTemplate("<a href='{Value}' class='btn btn-primary' role='button'>Edit</a>");
cols.Add("Delete").WithHtmlEncoding(false)
.WithSorting(false)
.WithHeaderText(" ")
.WithValueExpression((p, c) => c.UrlHelper.Action("detail", "demo", new { id = p.Id }))
.WithValueTemplate("<a href='{Value}' class='btn btn-danger' role='button'>Delete</a>");
cols.Add("Example").WithHtmlEncoding(false)
.WithSorting(false)
.WithHeaderText("Example")
.WithValueExpression((p, c) => p.Active ? "label-success" : "label-danger")
.WithValueTemplate("You can access any of the item's properties: <strong>{Model.FirstName}</strong> <br />or the current column value: <span class='label {Value}'>{Model.Active}</span>");
})
.WithSorting(true, "LastName")
.WithPaging(true, 20)
.WithRetrieveDataMethod((context) =>
{
var options = context.QueryOptions;
int totalRecords;
var repo = DependencyResolver.Current.GetService<IPersonRepository>();
string sortColumn = options.GetSortColumnData<string>();
var items = repo.GetData(out totalRecords,
options.GetLimitOffset(), options.GetLimitRowcount(),
sortColumn, options.SortDirection == SortDirection.Dsc);
return new QueryResult<Person>()
{
Items = items,
TotalRecords = totalRecords
};
})
);
MVCGridDefinitionTable.Add("CustomErrorMessage", new MVCGridBuilder<Person>(colDefauls)
.WithAuthorizationType(AuthorizationType.AllowAnonymous)
.AddColumns(cols =>
{
cols.Add("Id").WithSorting(false)
.WithValueExpression(p => p.Id.ToString());
cols.Add("FirstName").WithHeaderText("First Name")
.WithValueExpression(p => p.FirstName);
cols.Add("LastName").WithHeaderText("Last Name")
.WithValueExpression(p => p.LastName);
})
.WithErrorMessageHtml(@"<div class=""alert alert-danger"" role=""alert"">OH NO!!!</div>")
.WithSorting(true, "LastName")
.WithPaging(true)
.WithRetrieveDataMethod((context) =>
{
var options = context.QueryOptions;
var result = new QueryResult<Person>();
using (var db = new SampleDatabaseEntities())
{
var query = db.People.AsQueryable();
result.TotalRecords = query.Count();
if (!String.IsNullOrWhiteSpace(options.SortColumnName))
{
switch (options.SortColumnName.ToLower())
{
case "firstname":
throw new Exception("Test exception");
case "lastname":
query = query.OrderBy(p => p.LastName, options.SortDirection);
break;
}
}
if (options.GetLimitOffset().HasValue)
{
query = query.Skip(options.GetLimitOffset().Value).Take(options.GetLimitRowcount().Value);
}
result.Items = query.ToList();
}
return result;
})
);
MVCGridDefinitionTable.Add("UsageExample", new MVCGridBuilder<YourModelItem>()
.WithAuthorizationType(AuthorizationType.AllowAnonymous)
.AddColumns(cols =>
{
// Add your columns here
cols.Add("UniqueColumnName").WithHeaderText("Any Header")
.WithValueExpression(i => i.YourProperty); // use the Value Expression to return the cell text for this column
cols.Add().WithColumnName("UrlExample")
.WithHeaderText("Edit")
.WithValueExpression((i, c) => c.UrlHelper.Action("detail", "demo", new { id = i.YourProperty }));
})
.WithRetrieveDataMethod((context) =>
{
// Query your data here. Obey Ordering, paging and filtering paramters given in the context.QueryOptions.
// Use Entity Framwork, a module from your IoC Container, or any other method.
// Return QueryResult object containing IEnumerable<YouModelItem>
return new QueryResult<YourModelItem>()
{
Items = new List<YourModelItem>(),
TotalRecords = 0 // if paging is enabled, return the total number of records of all pages
};
})
);
MVCGridDefinitionTable.Add("GlobalSearchGrid", new MVCGridBuilder<Person>(colDefauls)
.WithAuthorizationType(AuthorizationType.AllowAnonymous)
.AddColumns(cols =>
{
cols.Add("Id").WithSorting(false)
.WithValueExpression(p => p.Id.ToString());
cols.Add("FirstName").WithHeaderText("First Name")
.WithValueExpression(p => p.FirstName);
cols.Add("LastName").WithHeaderText("Last Name")
.WithValueExpression(p => p.LastName);
})
.WithAdditionalQueryOptionNames("Search")
.WithAdditionalSetting("RenderLoadingDiv", false)
.WithSorting(true, "LastName")
.WithPaging(true, 10, true, 100)
.WithRetrieveDataMethod((context) =>
{
var options = context.QueryOptions;
int totalRecords;
var repo = DependencyResolver.Current.GetService<IPersonRepository>();
string globalSearch = options.GetAdditionalQueryOptionString("Search");
var items = repo.GetData(out totalRecords, globalSearch, options.GetLimitOffset(), options.GetLimitRowcount(),
options.SortColumnName, options.SortDirection == SortDirection.Dsc);
return new QueryResult<Person>()
{
Items = items,
TotalRecords = totalRecords
};
})
);
MVCGridDefinitionTable.Add("PageSizeGrid", new MVCGridBuilder<Person>(colDefauls)
.WithAuthorizationType(AuthorizationType.AllowAnonymous)
.AddColumns(cols =>
{
cols.Add("Id").WithSorting(false)
.WithValueExpression(p => p.Id.ToString());
cols.Add("FirstName").WithHeaderText("First Name")
.WithValueExpression(p => p.FirstName);
cols.Add("LastName").WithHeaderText("Last Name")
.WithValueExpression(p => p.LastName);
})
.WithSorting(true, "LastName")
.WithPaging(true, 10, true, 100)
.WithRetrieveDataMethod((context) =>
{
var options = context.QueryOptions;
int totalRecords;
var repo = DependencyResolver.Current.GetService<IPersonRepository>();
var items = repo.GetData(out totalRecords, options.GetLimitOffset(), options.GetLimitRowcount(),
options.SortColumnName, options.SortDirection == SortDirection.Dsc);
return new QueryResult<Person>()
{
Items = items,
TotalRecords = totalRecords
};
})
);
MVCGridDefinitionTable.Add("ColumnVisibilityGrid", new MVCGridBuilder<Person>(colDefauls)
.WithAuthorizationType(AuthorizationType.AllowAnonymous)
.AddColumns(cols =>
{
cols.Add("Id").WithSorting(false)
.WithValueExpression(p => p.Id.ToString());
cols.Add("FirstName").WithHeaderText("First Name")
.WithValueExpression(p => p.FirstName);
cols.Add("LastName").WithHeaderText("Last Name")
.WithValueExpression(p => p.LastName);
cols.Add("StartDate").WithHeaderText("Start Date")
.WithVisibility(false, true)
.WithValueExpression(p => p.StartDate.HasValue ? p.StartDate.Value.ToShortDateString() : "");
cols.Add("Status").WithSortColumnData("Active")
.WithHeaderText("Status")
.WithVisibility(false, true)
.WithValueExpression(p => p.Active ? "Active" : "Inactive")
.WithCellCssClassExpression((p, c) => p.Active ? "success" : "danger");
cols.Add("Gender")
.WithVisibility(false, true)
.WithValueExpression(p => p.Gender);
})
.WithSorting(true, "LastName")
.WithPaging(true, 10)
.WithRetrieveDataMethod((context) =>
{
var options = context.QueryOptions;
int totalRecords;
var repo = DependencyResolver.Current.GetService<IPersonRepository>();
var items = repo.GetData(out totalRecords, options.GetLimitOffset(), options.GetLimitRowcount(),
options.SortColumnName, options.SortDirection == SortDirection.Dsc);
return new QueryResult<Person>()
{
Items = items,
TotalRecords = totalRecords
};
})
);
MVCGridDefinitionTable.Add("NestedObjectTest", new MVCGridBuilder<Job>()
.WithAuthorizationType(AuthorizationType.AllowAnonymous)
.WithPaging(true)
.AddColumns(cols =>
{
cols.Add("Id", "Id", row => row.JobId.ToString());
cols.Add("Name", "Name", row => row.Name);
cols.Add("Contact")
.WithHeaderText("Contact")
.WithHtmlEncoding(false)
.WithSorting(true)
.WithValueExpression((p, c) => p.Contact != null ? c.UrlHelper.Action("Edit", "Contact", new { id = p.Contact.Id }) : "")
.WithValueTemplate("<a href='{Value}'>{Model.Contact.FullName}</a>").WithPlainTextValueExpression((p, c) => p.Contact != null ? p.Contact.FullName : "");
})
.WithRetrieveDataMethod((context) =>
{
var options = context.QueryOptions;
JobRepo repo = new JobRepo();
int totalRecords;
var data = repo.GetData(out totalRecords, null, options.GetLimitOffset(), options.GetLimitRowcount(), null, false);
return new QueryResult<Job>()
{
Items = data,
TotalRecords = totalRecords
};
})
);
MVCGridDefinitionTable.Add("PPGrid", new MVCGridBuilder<Person>(colDefauls)
.WithAuthorizationType(AuthorizationType.AllowAnonymous)
.WithPageParameterNames("Active")
.AddColumns(cols =>
{
cols.Add("Id").WithSorting(false)
.WithValueExpression(p => p.Id.ToString());
cols.Add("FirstName").WithHeaderText("First Name")
.WithValueExpression(p => p.FirstName);
cols.Add("LastName").WithHeaderText("Last Name")
.WithValueExpression(p => p.LastName);
})
.WithPreloadData(true)
.WithSorting(true, "LastName")
.WithPaging(true, 10)
.WithRetrieveDataMethod((context) =>
{
var options = context.QueryOptions;
int totalRecords;
var repo = DependencyResolver.Current.GetService<IPersonRepository>();
string ppactive = options.GetPageParameterString("active");
bool filterActive = bool.Parse(ppactive);
var items = repo.GetData(out totalRecords, null,null, filterActive, options.GetLimitOffset(), options.GetLimitRowcount(),
options.GetSortColumnData<string>(), options.SortDirection == SortDirection.Dsc);
return new QueryResult<Person>()
{
Items = items,
TotalRecords = totalRecords
};
})
);
MVCGridDefinitionTable.Add("QPLGrid", new MVCGridBuilder<Person>(colDefauls)
.WithAuthorizationType(AuthorizationType.AllowAnonymous)
.WithQueryOnPageLoad(false)
.WithPreloadData(false)
.AddColumns(cols =>
{
cols.Add("Id").WithSorting(false)
.WithValueExpression(p => p.Id.ToString());
cols.Add("FirstName").WithHeaderText("First Name")
.WithValueExpression(p => p.FirstName);
cols.Add("LastName").WithHeaderText("Last Name")
.WithValueExpression(p => p.LastName);
})
.WithSorting(true, "LastName")
.WithPaging(true, 10)
.WithRetrieveDataMethod((context) =>
{
var options = context.QueryOptions;
int totalRecords;
var repo = DependencyResolver.Current.GetService<IPersonRepository>();
var items = repo.GetData(out totalRecords, options.GetLimitOffset(), options.GetLimitRowcount(),
options.GetSortColumnData<string>(), options.SortDirection == SortDirection.Dsc);
return new QueryResult<Person>()
{
Items = items,
TotalRecords = totalRecords
};
})
);
//MVCGridDefinitionTable.Add DO NOT DELETE - Needed for demo code parsing
GridDefinition<YourModelItem> def = new GridDefinition<YourModelItem>();
GridColumn<YourModelItem> column = new GridColumn<YourModelItem>();
column.ColumnName = "UniqueColumnName";
column.HeaderText = "Any Header";
column.ValueExpression = (i, c) => i.YourProperty;
def.AddColumn(column);
def.RetrieveData = (options) =>
{
return new QueryResult<YourModelItem>()
{
Items = new List<YourModelItem>(),
TotalRecords = 0
};
};
MVCGridDefinitionTable.Add("NonFluentUsageExample", def);
GridDefaults defaultSet1 = new GridDefaults()
{
Paging = true,
ItemsPerPage = 20,
Sorting = true,
NoResultsMessage = "Sorry, no results were found"
};
MVCGridDefinitionTable.Add("DefaultsExample",
new MVCGridBuilder<YourModelItem>(defaultSet1) // pass in defauls object to ctor
.AddColumns(cols =>
{
// add columns
})
.WithDefaultSortColumn("Test")
.WithRetrieveDataMethod((context) =>
{
//get data
return new QueryResult<YourModelItem>();
})
);
var docsReturnTypeColumn = new GridColumn<MethodDocItem>()
{
ColumnName = "ReturnType",
HeaderText = "Return Type",
HtmlEncode = false,
ValueExpression = (p, c) => String.Format("<code>{0}</code>", HttpUtility.HtmlEncode(p.Return))
};
var docsNameColumn = new GridColumn<MethodDocItem>()
{
ColumnName = "Name",
HtmlEncode = false,
ValueExpression = (p, c) => String.Format("<code>{0}</code>", HttpUtility.HtmlEncode(p.Name))
};
var docsDescriptionColumn = new GridColumn<MethodDocItem>()
{
ColumnName = "Description",
ValueExpression = (p, c) => p.Description
};
Func<GridContext, QueryResult<MethodDocItem>> docsLoadData = (context) =>
{
var result = new QueryResult<MethodDocItem>();
DocumentationRepository repo = new DocumentationRepository();
result.Items = repo.GetData(context.GridName);
return result;
};
MVCGridDefinitionTable.Add("GridDefinition", new MVCGridBuilder<MethodDocItem>()
.AddColumn(docsNameColumn)
.AddColumn(docsReturnTypeColumn)
.AddColumn(docsDescriptionColumn)
.WithRetrieveDataMethod(docsLoadData)
);
MVCGridDefinitionTable.Add("GridColumn", new MVCGridBuilder<MethodDocItem>()
.AddColumn(docsNameColumn)
.AddColumn(docsReturnTypeColumn)
.AddColumn(docsDescriptionColumn)
.WithRetrieveDataMethod(docsLoadData)
);
MVCGridDefinitionTable.Add("QueryOptions", new MVCGridBuilder<MethodDocItem>()
.AddColumn(docsNameColumn)
.AddColumn(docsReturnTypeColumn)
.AddColumn(docsDescriptionColumn)
.WithRetrieveDataMethod(docsLoadData)
);
MVCGridDefinitionTable.Add("ClientSide", new MVCGridBuilder<MethodDocItem>()
.AddColumn(docsNameColumn)
.AddColumn(docsDescriptionColumn)
.WithRetrieveDataMethod(docsLoadData)
);
}
public IEnumerable<Person> GetData(out int totalRecords, string globalSearch, string filterFirstName, string filterLastName, bool? filterActive, int? limitOffset, int? limitRowCount, string orderBy, bool desc)
{
using (var db = new SampleDatabaseEntities())
{
var query = db.People.AsQueryable();
if (!String.IsNullOrWhiteSpace(filterFirstName))
{
query = query.Where(p => p.FirstName.Contains(filterFirstName));
}
if (!String.IsNullOrWhiteSpace(filterLastName))
{
query = query.Where(p => p.LastName.Contains(filterLastName));
}
if (filterActive.HasValue)
{
query = query.Where(p => p.Active == filterActive.Value);
}
if (!String.IsNullOrWhiteSpace(globalSearch))
{
query = query.Where(p => (p.FirstName + " " + p.LastName).Contains(globalSearch));
}
totalRecords = query.Count();
if (!String.IsNullOrWhiteSpace(orderBy))
{
switch (orderBy.ToLower())
{
case "firstname":
if (!desc)
query = query.OrderBy(p => p.FirstName);
else
query = query.OrderByDescending(p => p.FirstName);
break;
case "lastname":
if (!desc)
query = query.OrderBy(p => p.LastName);
else
query = query.OrderByDescending(p => p.LastName);
break;
case "active":
if (!desc)
query = query.OrderBy(p => p.Active);
else
query = query.OrderByDescending(p => p.Active);
break;
case "email":
if (!desc)
query = query.OrderBy(p => p.Email);
else
query = query.OrderByDescending(p => p.Email);
break;
case "gender":
if (!desc)
query = query.OrderBy(p => p.Gender);
else
query = query.OrderByDescending(p => p.Gender);
break;
case "id":
if (!desc)
query = query.OrderBy(p => p.Id);
else
query = query.OrderByDescending(p => p.Id);
break;
case "startdate":
if (!desc)
query = query.OrderBy(p => p.StartDate);
else
query = query.OrderByDescending(p => p.StartDate);
break;
}
}
if (limitOffset.HasValue)
{
query = query.Skip(limitOffset.Value).Take(limitRowCount.Value);
}
return query.ToList();
}
}
