Hide

YetaWF.Core Package Documentation

Display
Print

YetaWF.Core.Controllers.ControllerImpl Class

Abstract base class for any module-based controller.

Namespace: YetaWF.Core.Controllers
Assembly: YetaWF.Core

Inheritance

Syntax

public abstract class ControllerImpl : YetaWF.Core.Controllers.YetaWFController;

Constructors

This class cannot be instantiated.

Properties

PublicAreaReturn the area name.
PublicClassNameReturns the class name.
PublicCompanyNameReturn the company name.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerBaseControllerContextGets or sets the ControllerContext.
PublicControllerNameReturns the controller name.
PublicDomainReturns the company's domain name.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerBaseHttpContextGets the HttpContext for the executing action.
PublicIsApplyReturns whether the current form submission used the Apply button to submit the form.
PublicIsReloadReturns whether the current form submission is intended to reload the form without validation, essentially Apply without validation.
PublicIsSubmitReturns whether the current form submission used the Submit button to submit the form.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerBaseMetadataProviderGets or sets the IModelMetadataProvider.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerBaseModelBinderFactoryGets or sets the IModelBinderFactory.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerBaseModelStateGets the ModelStateDictionary that contains the state of the model and of model-binding validation.
PublicModuleNameReturns the module name.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerBaseObjectValidatorGets or sets the IObjectModelValidator.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerBaseProblemDetailsFactoryGets or sets the ProblemDetailsFactory.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerBaseRequestGets the HttpRequest for the executing action.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerBaseResponseGets the HttpResponse for the executing action.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerBaseRouteDataGets the RouteData for the executing action.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerTempDataGets or sets ITempDataDictionary used by ViewResult.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerBaseUrlGets or sets the IUrlHelper.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerBaseUserGets the ClaimsPrincipal for user associated with the executing action.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerViewBagGets the dynamic view bag.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerViewDataGets or sets ViewDataDictionary used by ViewResult and ViewBag.
ProtectedInherited from YetaWF.Core.Controllers.YetaWFControllerCurrentModuleReturns the module definitions YetaWF.Core.Modules.ModuleDefinition for the current module implementing the controller (if any). Can be used with a base class to get the derived module's module definitions.
ProtectedStaticInherited from YetaWF.Core.Controllers.YetaWFControllerManagerThe YetaWFManager instance for the current HTTP request.

Methods

PublicInherited from Microsoft.AspNetCore.Mvc.ControllerBaseAcceptedCreates a AcceptedResult object that produces an Status202Accepted response.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerBaseAcceptedAtActionCreates a AcceptedAtActionResult object that produces an Status202Accepted response.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerBaseAcceptedAtRouteCreates a AcceptedAtRouteResult object that produces an Status202Accepted response.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerBaseBadRequestCreates an BadRequestResult that produces a Status400BadRequest response.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerBaseChallengeCreates a ChallengeResult.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerBaseConflictCreates an ConflictResult that produces a Status409Conflict response.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerBaseContentCreates a ContentResult object by specifying a content string.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerBaseCreatedCreates a CreatedResult object that produces a Status201Created response.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerBaseCreatedAtActionCreates a CreatedAtActionResult object that produces a Status201Created response.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerBaseCreatedAtRouteCreates a CreatedAtRouteResult object that produces a Status201Created response.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerDispose(not specified)
PublicInherited from System.ObjectEqualsDetermines whether the specified object is equal to the current object.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerBaseFileReturns a file with the specified fileContents as content (Status200OK), and the specified contentType as the Content-Type. This supports range requests (Status206PartialContent or Status416RangeNotSatisfiable if the range is not satisfiable).
ProtectedInherited from System.ObjectFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerBaseForbidCreates a ForbidResult (Status403Forbidden by default).
ProtectedFormProcessedThe page/form was successfully processed. This handles returning to a parent page or displaying a popup if a return page is not available.
PublicGetActionUrlReturns the URL for the requested action with the specified arguments formatted as query string.
PublicInherited from System.ObjectGetHashCodeServes as the default hash function.
ProtectedInherited from YetaWF.Core.Controllers.YetaWFControllerGetModuleAsyncReturns the module definitions YetaWF.Core.Modules.ModuleDefinition for the current module implementing the controller. Can be used with a base class to get the derived module's module definitions.
ProtectedGetObjectFromModelAsyncUsed by ModuleEdit controller only - ModuleEdit edits a generic ModuleDefinition so we need to bind it to the correct type from the controller.
PublicInherited from System.ObjectGetTypeGets the Type of the current instance.
ProtectedInherited from YetaWF.Core.Controllers.YetaWFControllerGridPartialViewAsyncReturns an action result that renders grid contents as a partial view.
ProtectedInherited from YetaWF.Core.Controllers.YetaWFControllerGridRecordViewAsync(not specified)
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerJsonCreates a JsonResult object that serializes the specified data object to JSON.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerBaseLocalRedirectCreates a LocalRedirectResult object that redirects (Status302Found) to the specified local localUrl.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerBaseLocalRedirectPermanentCreates a LocalRedirectResult object with Permanent set to true (Status301MovedPermanently) using the specified localUrl.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerBaseLocalRedirectPermanentPreserveMethodCreates a LocalRedirectResult object with Permanent set to true and PreserveMethod set to true (Status308PermanentRedirect) using the specified localUrl.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerBaseLocalRedirectPreserveMethodCreates a LocalRedirectResult object with Permanent set to false and PreserveMethod set to true (Status307TemporaryRedirect) using the specified localUrl.
PublicStaticInherited from YetaWF.Core.Controllers.YetaWFControllerMakeFullViewNameUpdate an area's view name with the complete area specifier.
ProtectedInherited from YetaWF.Core.Controllers.YetaWFControllerMarkNotFoundCurrent request is marked 404 (Not Found).
ProtectedInherited from System.ObjectMemberwiseCloneCreates a shallow copy of the current Object.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerBaseNoContentCreates a NoContentResult object that produces an empty Status204NoContent response.
ProtectedNotAuthorizedAn action result that results in a 403 Not Authorized exception.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerBaseNotFoundCreates an NotFoundResult that produces a Status404NotFound response.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerBaseOkCreates a OkResult object that produces an empty Status200OK response.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerOnActionExecutedCalled after the action method is invoked.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerOnActionExecutingCalled before the action method is invoked.
PublicOnActionExecutionAsyncCalled when an action is about to be executed.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerPartialViewCreates a PartialViewResult object that renders a partial view to the response.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerBasePhysicalFileReturns the file specified by physicalPath (Status200OK) with the specified contentType as the Content-Type. This supports range requests (Status206PartialContent or Status416RangeNotSatisfiable if the range is not satisfiable).
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerBaseProblemCreates an ObjectResult that produces a ProblemDetails response.
ProtectedRedirectRedirect to the specified target defined by the supplied action.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerBaseRedirectPermanentCreates a RedirectResult object with Permanent set to true (Status301MovedPermanently) using the specified url.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerBaseRedirectPermanentPreserveMethodCreates a RedirectResult object with Permanent set to true and PreserveMethod set to true (Status308PermanentRedirect) using the specified url.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerBaseRedirectPreserveMethodCreates a RedirectResult object with Permanent set to false and PreserveMethod set to true (Status307TemporaryRedirect) using the specified url.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerBaseRedirectToActionRedirects (Status302Found) to an action with the same name as current one. The 'controller' and 'action' names are retrieved from the ambient values of the current request.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerBaseRedirectToActionPermanentRedirects (Status301MovedPermanently) to the specified action with Permanent set to true using the specified actionName.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerBaseRedirectToActionPermanentPreserveMethodRedirects (Status308PermanentRedirect) to the specified action with Permanent set to true and PreserveMethod set to true, using the specified actionName, controllerName, routeValues, and fragment.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerBaseRedirectToActionPreserveMethodRedirects (Status307TemporaryRedirect) to the specified action with Permanent set to false and PreserveMethod set to true, using the specified actionName, controllerName, routeValues, and fragment.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerBaseRedirectToPageRedirects (Status302Found) to the specified pageName.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerBaseRedirectToPagePermanentRedirects (Status301MovedPermanently) to the specified pageName.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerBaseRedirectToPagePermanentPreserveMethodRedirects (Status308PermanentRedirect) to the specified route with Permanent set to true and PreserveMethod set to true, using the specified pageName, routeValues, and fragment.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerBaseRedirectToPagePreserveMethodRedirects (Status307TemporaryRedirect) to the specified page with Permanent set to false and PreserveMethod set to true, using the specified pageName, routeValues, and fragment.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerBaseRedirectToRouteRedirects (Status302Found) to the specified route using the specified routeName.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerBaseRedirectToRoutePermanentRedirects (Status301MovedPermanently) to the specified route with Permanent set to true using the specified routeName.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerBaseRedirectToRoutePermanentPreserveMethodRedirects (Status308PermanentRedirect) to the specified route with Permanent set to true and PreserveMethod set to true, using the specified routeName, routeValues, and fragment.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerBaseRedirectToRoutePreserveMethodRedirects (Status307TemporaryRedirect) to the specified route with Permanent set to false and PreserveMethod set to true, using the specified routeName, routeValues, and fragment.
ProtectedRedirectToUrlRedirects to the specified URL, aborting page rendering. Can be used with UPS.
PublicStaticInherited from System.ObjectReferenceEqualsDetermines whether the specified Object instances are the same instance.
ProtectedReloadReturns an action result, indicating that the submission was successfully processed, causing a page or module reload, optionally with a popup message.
ProtectedInherited from YetaWF.Core.Controllers.YetaWFControllerReload_Page(not specified)
ProtectedReturnSuccessReturn a JSON object indicating success.
PublicStaticInherited from YetaWF.Core.Controllers.YetaWFControllerSetupEnvironmentInfoAsync(not specified)
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerBaseSignInCreates a SignInResult.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerBaseSignOutCreates a SignOutResult.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerBaseStatusCodeCreates a StatusCodeResult object by specifying a statusCode.
PublicInherited from System.ObjectToStringReturns a string that represents the current object.
ProtectedInherited from YetaWF.Core.Controllers.YetaWFControllerTreePartialViewAsyncReturns an action result that renders tree contents as a partial view.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerBaseTryUpdateModelAsyncUpdates the specified model instance using values from the controller's current IValueProvider.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerBaseTryValidateModelValidates the specified model instance.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerBaseUnauthorizedCreates an UnauthorizedResult that produces an Status401Unauthorized response.
ProtectedUniqueIdReturns a unique id usable for HTML.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerBaseUnprocessableEntityCreates an UnprocessableEntityResult that produces a Status422UnprocessableEntity response.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerBaseValidationProblemCreates an BadRequestObjectResult that produces a Status400BadRequest response.
ProtectedViewInvokes a view from a module controller.
PublicInherited from Microsoft.AspNetCore.Mvc.ControllerViewComponentCreates a ViewComponentResult by specifying the name of a view component to render.

Enums

ProtectedOnApplyEnumThe type of processing used when processing the Apply action for a form, used with the FormProcessed method.
ProtectedOnCloseEnumThe type of processing used when closing a page, used with the FormProcessed method.
ProtectedOnPopupCloseEnumThe type of processing used when closing a popup window, used with the FormProcessed method.
ProtectedReloadEnumThe type of form reload used with the Reload method.

See Also YetaWF.Core Overview