Previous Page Next Page

Serenity.Net.Web assembly

Serenity namespace

signature name description
static class ArgumentExceptions This class contains methods for creating ArgumentException and subclasses while avoiding analyzer warnings regarding mismatched argument names.
static class DataProtectorBinaryTokenExtensions Extension methods for IDataProtector to support tokens created via a BinaryWriter.
class ScriptCulture Culture options that are passed to the client side.

Serenity.ComponentModel namespace

signature name description
class EmailEditorAttribute Email editor type with two inputs. Prefer EmailAddressEditorAttribute which uses a single input.

Serenity.Data namespace

signature name description
static class ForXmlHelper Helper to generate T-SQL FOR XML RAW statements.

Serenity.Extensions.DependencyInjection namespace

signature name description
static class ApplicationPartsServiceCollectionExtensions DI extension methods related to application parts and type source.
static class DynamicScriptServiceCollectionExtensions Contains DI extension methods related to dynamic script services.
static class EsBuildMinifierExtensions Extensions for adding EsBuild minifiers to an IServiceCollection.
static class HttpContextServiceCollectionExtensions DI extension methods related to the HTTP context.
static class NodeScriptRunnerExtensions Contains extension methods for NodeScriptRunner.
static class ServiceCollectionConfigureExtensions DI extension methods related to configuration and options
static class ServiceEndpointServiceCollectionExtensions DI extension methods related to service endpoints.
static class UploadServiceCollectionExtensions DI extension methods related to upload services.

Serenity.Navigation namespace

signature name description
class NavigationHelper Contains helper methods for navigation models and items.
class NavigationLinkAttribute A navigation item with a link.

Serenity.Reporting namespace

signature name description
class DefaultReportFactory Default implementation of IReportFactory.
class DefaultReportRenderer Default implementation of IReportRenderer.
class WKHtmlToPdf HTML to PDF converter class using WKHTMLToPdf.
class WKHtmlToPdfConverter Implementation of IWKHtmlToPdfConverter.
class WKHtmlToPdfSettings Set of WKHTMLToPdf settings.

Serenity.Services namespace

signature name description
class AntiforgeryCookieResultFilterAttribute Appends the anti forgery token as a CSRF-TOKEN cookie to the response, so that AJAX calls can read it client side and send it as a header.
class AuthorizeCreateAttribute Authorizes access to a service method by reading one of InsertPermissionAttribute, ModifyPermissionAttribute or ReadPermissionAttribute from the target type, which is usually a Row class.
class AuthorizeDeleteAttribute Authorizes access to a service method by reading one of DeletePermissionAttribute, ModifyPermissionAttribute or ReadPermissionAttribute from the target type, which is usually a Row class.
class AuthorizeListAttribute Authorizes access to a service method by reading ReadPermissionAttribute. It also allows lookup mode access (as an OR permission) if the source type has ServiceLookupPermissionAttribute.
class AuthorizeRetrieveAttribute Authorizes retrieve access to a service method by reading ReadPermissionAttribute.
class AuthorizeUpdateAttribute Authorizes access to a service method by reading one of UpdatePermissionAttribute, ModifyPermissionAttribute or ReadPermissionAttribute from the target type, which is usually a Row class.
static class EndpointExtensions Contains some extensions for service endpoints.
class FileUploadBehavior Behavior class that handles FileUploadEditorAttribute and ImageUploadEditorAttribute.
class HandleControllerExceptionAttribute An exception filter attribute to handle controller exceptions and return them as a view.
class HandleServiceExceptionAttribute An exception filter attribute to handle service exceptions and return them as ServiceResponse objects.
class JsonRequestAttribute An action filter for methods that accept JSON content via their "request" arguments.
class Result<TResponse> An action result type containing an object.
class ResultWithStatus<TResponse> An action result type containing an object with a status code.
class ServiceAuthorizeAttribute Authorizes access to a service action. Optionally checks the permission provided as the first argument. Use special permission key ? to check for logged-in users, and * to allow anyone including anonymous access. This returns a service error instead of raising an exception like PageAuthorizeAttribute.
abstract class ServiceEndpoint Subclass of controller for service endpoints.
class ServiceEndpointActionModelConvention Action model convention for ServiceEndpoint actions.
class ServiceEndpointApplicationModelProvider Applies action model conventions for ServiceEndpoint controllers.
class ServiceEndpointBindingMetadataProvider An IBindingMetadataProvider which configures ModelMetadata.IsBindingAllowed to false for IDbConnection and IUnitOfWork types.
class ServiceEndpointModelBinderProvider Provides model binding for service endpoints.
class ServiceEndpointNullModelBinder Null model binder for interface arguments.

Serenity.Web namespace

signature name description
class AntiforgeryFilterOptions Options for AutoValidateAntiforgeryIgnoreBearerFilter.
class ApplicationPartsTypeSource Implementation of a type source that uses ApplicationPartManager to get assemblies. Note that it only includes assemblies that are marked with TypeSourceAssemblyAttribute, which is automatically added to assemblies that reference the Serenity.Net.Web NuGet package (or Serenity.Net.Web.targets).
class AutoValidateAntiforgeryIgnoreBearerAttribute An attribute that causes validation of antiforgery tokens for all unsafe HTTP methods. An antiforgery token is required for HTTP methods other than GET, HEAD, OPTIONS, and TRACE, and when there is no cookie header and authorization is Bearer, e.g. JWT.
abstract class BaseDynamicDataGenerator Base class for generating .json files under the dynamic-data folder for script testing purposes.
static class CheckTreeEditorTexts
static class ColumnPickerDialogTexts
class ColumnsScriptRegistration Contains registration methods for ColumnsScript types.
class ContentHashCache Default IContentHashCache implementation.
class CssBundleManager Default implementation of ICssBundleManager.
class CssBundlingOptions Options for CSS bundling.
class CssMinifyOptions Set of options for CSS minifying.
class CssMinifyResult Result returned from a CSS minifier.
static class DataGridTexts
class DataScriptRegistration Contains helper methods for data script registration.
static class DateTimeEditorTexts
class DefaultFileWatcherFactory Default implementation of IFileWatcherFactory that keeps created watchers alive for the lifetime of the factory.
class DefaultLocalTextInitializer Default ILocalTextInitializer that registers base texts and JSON texts from the App_Data/texts folder.
class DefaultUploadFileResponder Default implementation of the upload file responder.
class DefaultUploadStorage Default IUploadStorage implementation which uses a combined upload storage of two DiskUploadStorage instances.
static class DialogTexts
class DistinctValuesRegistration Contains helper methods for distinct values scripts.
class DistinctValuesScript<TRow> A dynamic script type for distinct values of a field.
class DynamicScriptManager Default implementation of IDynamicScriptManager.
static class EntityDialogTexts
static class EntityGridTexts
static class ExcelContentResult Excel content result helper methods.
class FeatureBarrierAttribute An attribute that can be placed on MVC controllers, controller actions, or Razor pages to require all or any of a set of features to be enabled. Note that if no IFeatureToggles service is registered, the feature barrier will always pass.
class FileWatcher Default file watcher implementation for the physical file system.
static class FilterPanelTexts
class FormScriptRegistration Contains registration methods for FormScript types.
static class FormValidationTexts
static class HtmlContentEditorTexts
static class HtmlCspExtensions Contains CSP related extension methods for HTML helpers and HTTP contexts.
static class HtmlImportMapExtensions Contains import map related extension methods for HTML helpers and HTTP contexts.
static class HtmlScriptExtensions Contains Serenity related helper methods that can be used in Razor CSHTML files.
class HttpContextItemsAccessor Default implementation of IHttpContextItemsAccessor that reads the HttpContext items.
class HttpContextUserAccessor Default implementation of IUserAccessor that reads the current user from the HTTP context.
static class HttpRequestExtensions Contains HTTP request related extensions.
interface ICacheSuffix Abstraction to get the cache suffix used while generating the key for a cached dynamic script.
interface IContentHashCache An abstraction for a content hash cache, which contains hashes of web servable files.
interface ICssBundleManager Abstraction for a CSS bundling manager.
interface ICssMinifier Abstraction for a CSS minifier.
interface IDynamicScriptManager Dynamic script manager abstraction.
interface IFileWatcher Abstraction for a file system watcher.
interface IFileWatcherFactory An abstract factory for creating file system watchers.
interface IScriptBundleManager Abstraction for a script bundling manager.
interface IScriptMinifier Abstraction for a script minifier.
interface IUploadFileResponder Abstraction for reading a file via /upload/path, e.g. the Read action in the FilePage.
static class KnownMimeTypes Contains a set of known popular mime types.
class LocalTextDataScript Local text data script to access local texts from an external app like mobile.
class LocalTextScript Local text dynamic script.
abstract class LookupScript Dynamic script type for lookup scripts.
class LookupScriptRegistration Contains helper methods for lookup script registration.
class NodeScriptRunner Executes the script entries defined in a package.json file, capturing any output written to stdio.
class NuglifyMinifier Default implementation of IScriptMinifier and ICssMinifier using the Nuglify library.
class PageAuthorizeAttribute Authorizes access to a controller action. Optionally checks the permission provided as the first argument. Use special permission key ? to check for logged-in users, and * to allow anyone including anonymous access.
static class PagerTexts
static class PropertyGridTexts
static class QuickSearchTexts
class RecaptchaPropertyProcessor Property processor that passes the recaptcha site key to the client side.
static class RecaptchaValidation Recaptcha validation extensions. This was written for a very old version of Google Recaptcha and might not work properly.
class RegisteredScripts A dynamic script type for registered scripts.
class RowLookupScript<TRow> Generic lookup script type for rows.
class ScriptBundleManager Default implementation of IScriptBundleManager.
class ScriptBundlingOptions Options for script bundling.
class ScriptContent Default implementation of IScriptContent.
class ScriptMinifyOptions Set of options for script minifying.
class ScriptMinifyResult Result returned from a script minifier.
static class SelectEditorTexts
static class TemplateHelper Helper methods for CSHTML templating.
static class VirtualPathUtility Extension methods providing partial compatibility with the legacy VirtualPathUtility.
static class WebTexts
class WebTypeSource Base type source for apps using the Serenity.Web assembly and its reference chain.

Serenity.Web.Middleware namespace

signature name description
class DynamicScriptMiddleware Dynamic script middleware that handles /DynJS.axd/ and /DynamicData/ paths.

Serenity.Web.Providers namespace

signature name description
static class SiteMembershipProvider Used to be a membership provider but now only contains a SHA512 helper.