Login
An instance of this class is associated with each HTTP request.
An instance of this class contains information about the current HTTP request. Most of it is obtained as needed (lazy loading). Important items such as logged on user, global information, etc. is accessible through this instance.
The instance can be retrieved using the static property YetaWFManager.Manager (YetaWF.Core.Support.YetaWFManager.Manager). Controllers, modules and components and many others provide an accessor in their base classes.
I can hear the Dependency Injection crowd moaning that this is not a good pattern. Sometimes getting things done is more important than technical perfection, which ultimately doesn't make the result any better, or user friendly. Sometimes things are really just global. And really, who cares.
Because of the abstraction provided by YetaWF with the YetaWFManager, it is possible to write simple console applications that use all the services of YetaWF, including data providers. These are not .NET based, they are "plain old" console applications.
Namespace: YetaWF.Core.Support
Assembly: YetaWF.Core
Inheritance
public class YetaWFManager;
This class cannot be instantiated.
 | ActiveDevice | (not specified) |
| AddOnManager | Returns the instance of AddOnManager associated with the current HTTP request. |
| AddonsCustomSiteFolder | The physical location (path) of the site's custom addons folder. |
| AntiForgeryTokenHTML | Cache rendered HTML for anti-forgery token. |
 | CacheBuster | Returns a string that can be used in generated URLs as "cache buster", i.e., to defeat client-side caching. |
| CanUseCDN | Returns whether a CDN can be used for website data. |
| CanUseCDNComponents | (not specified) |
| CanUseStaticDomain | (not specified) |
| ComponentsData | This property can be used by a component rendering package to save information for the current HTTP request. It is not used by YetaWF. |
| CssManager | Returns the instance of CssManager associated with the current HTTP request. |
| CurrentContext | (not specified) |
| CurrentModule | (not specified) |
| CurrentModuleEdited | (not specified) |
| CurrentPage | The current page. |
| CurrentRequest | (not specified) |
| CurrentRequestUrl | Describes the current URL requested. CurrentRequestUrl may not match the full page URL in UPS requests. |
| CurrentResponse | (not specified) |
| CurrentSession | (not specified) |
| CurrentSessionId | (not specified) |
| CurrentSite | The current site definition. The current site is identified based on the URL of the current request. |
| CurrentUrl | Describes the current URL (path and query string only) requested, as shown by browser, which matches the page URL. CurrentRequestUrl may not match the full page URL in UPS requests. |
| DataFolder | The physical location (path) of the Data folder (not site specific). |
| DefaultSiteName | Returns the default site name used for this instance of YetaWF. |
| Deployed | Defines whether the currently running instance of YetaWF is a deployed instance or not. |
| DiagnosticsMode | Defines whether the currently running instance of YetaWF is using additional run-time diagnostics to find issues, typically used during development. |
| EditMode | (not specified) |
| ForceModuleActionLinks | (not specified) |
| HasSuperUserRole | (not specified) |
| HaveCurrentContext | (not specified) |
| HaveCurrentRequest | (not specified) |
| HaveCurrentSession | (not specified) |
| HaveCurrentSite | Returns whether information about the current site is available. This may return false during startup or before processing the current HTTP request has started. |
| HaveManager | Determines whether a YetaWFManager instance is available. |
| HaveReturnToUrl | (not specified) |
| HaveUser | (not specified) |
| HostPortUsed | The port used to access this website. |
| HostSchemeUsed | The scheme used to access this website. |
| HostUsed | The host used to access this website. |
| HttpContextAccessor | A global instance of Microsoft.AspNetCore.Http.IHttpContextAccessor. For internal framework use only. |
| ImportChunksNonSiteSpecifics | Defines whether non-site specific data is also imported when importing packages |
| InPartialView | True while processing a partial view (usually a partial form/ajax) |
| IsBatchMode | Returns whether the current application is running in batch mode. |
| IsDemo | Defines whether the current YetaWF instance runs in demo mode. |
| IsDemoUser | Defines whether the current user has the "Demo" role. |
| IsGetRequest | (not specified) |
| IsHeadRequest | (not specified) |
| IsHTTPSite | Defines whether the domain uses http:// only (overrides site/page settings) |
| IsInPopup | Returns whether we're in a popup. |
| IsLocalHost | Defines whether localhost/127.0.0.1 was used to access this website. |
| IsPostRequest | (not specified) |
| IsRenderingPane | (not specified) |
| IsServiceMode | Returns whether the current application is a service application (API). |
| IsStaticSite | Defines whether the current request is for the static site. A static site URL can be defined using Admin > Settings > Site Settings, CDN tab, Static Files Domain. |
| IsTestSite | Defines whether the test domain was used to access this website. |
| LastUpdated | Contains the page's last date/time updated while rendering a page. |
| LicenseFolder | The physical location (path) of the product license folder (not site specific). This is used by third-party licensed products only. |
| LinkAltManager | Returns the instance of LinkAltManager associated with the current HTTP request. |
| LocalizationSupportEnabled | (not specified) |
| Manager | Returns the instance of the YetaWFManager class associated with the current HTTP request. |
| MemoryCache | A global instance of Microsoft.Extensions.Caching.Memory.IMemoryCache. For internal framework use only. |
| MetatagsHtml | Used by skin modules to retrieve all meta tags as an HTML string. |
| MetatagsManager | Returns the instance of MetatagsManager associated with the current HTTP request. |
| Mode | Defines the current run-time mode. Currently defined are batch mode and service mode. Is neither is set, this is a web application. |
| ModeCss | (not specified) |
| Need2FA | Currently logged on user is authenticated but needs to set up two-step authentication. |
| Need2FARedirect | (not specified) |
| Need2FAState | (not specified) |
| NeedNewPassword | Currently logged on user is authenticated but needs to define a new password. |
| NestedComponentPrefix | (not specified) |
| OriginList | Saved URL where we came from (e.g. used for return handling after Save). TODO: This needs some rework. |
| PageControlShown | Returns whether the page control module is visible. |
| PageTitle | The current page title. Modules can override the page title (we don't use the title in the page definition, except to set the default title). |
| PageTitleHtml | (not specified) |
| PaneRendered | The current pane being rendered. |
| QueryReturnToUrl | Returns the last entry of the OriginList without removing it. |
| ReferrerUrl | (not specified) |
| RenderContentOnly | Set when rendering content only (UPS) |
| RenderingUniqueModuleAddons | (not specified) |
| RenderingUniqueModuleAddonsAjax | (not specified) |
| RenderStaticPage | Indicates whether the current page being rendered is actually rendered as a static page. |
| RequestForm | Returns the current HTTP request's form information. |
| RequestQueryString | Returns the current HTTP request's query string. |
| ReturnToUrl | Returns the Url to return to, including origin list and other querystring parms. |
| RootFolder | The physical location (path) of the website's root folder (wwwroot on .NET - MVC). |
| RootFolderSolution | The physical location (path) of the Solution (*.sln) root folder. |
| RootFolderWebProject | The physical location (path) of the Website project (Website.csproj) root folder. |
| RootSitesFolder | Returns the folder containing all sites' file data. |
| ScriptManager | Returns the instance of ScriptManager associated with the current HTTP request. |
| ServiceProvider | A global instance of System.IServiceProvider. For internal framework use only. |
| SessionSettings | (not specified) |
| SiteCreationTemplateActive | (not specified) |
| SiteDomain | The current site's domain - E.g., softelvdm.com, localhost, etc. |
| SiteFolder | The physical location (path) containing the current site's file data. |
| SkinInfo | Returns skin information for the skin used by the current page. |
| StaticCacheDuration | (not specified) |
| StaticPageManager | Returns the instance of StaticPageManager associated with the current HTTP request. |
| UniqueIdCounters | (not specified) |
| UserAuthorizedUrls | (not specified) |
| UserEmail | (not specified) |
| UserHostAddress | Returns the user's IP address. If none is available, an empty string is returned. |
| UserId | (not specified) |
| UserLanguage | (not specified) |
| UserName | (not specified) |
| UserNotAuthorizedUrls | (not specified) |
| UserObject | (not specified) |
| UserRoles | (not specified) |
| UserSettingsObject | (not specified) |
| VaultFolder | The physical location (path) of the Vault folder (not site specific). |
| VaultPrivateFolder | The physical location (path) of the Vault private folder (not site specific). |
| WantFocus | (not specified) |
| BATCHMODE | Defines the run-time mode used by console applications. |
| ComponentPackagesSeen | (not specified) |
| ComponentsSeen | (not specified) |
| SERVICEMODE | Defines the run-time mode used by service application (API). |
 | AddUrlArg | Add a temporary (non-visible) URL query string argument to the current page being rendered. This is mainly used to propagate selections from one module to another (top-down on page only). Other modules must use TryGetUrlArg or GetUrlArg to retrieve these arguments as they're not part of the actual query string/URL. TO BE REMOVED. |
 | Equals | Determines whether the specified object is equal to the current object. |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. |
| GetCDNUrl | (not specified) |
| GetCultureInfo | (not specified) |
| GetHashCode | Serves as the default hash function. |
| GetPackageData | Retrieves saved data for a package. |
| GetRequestedDomain | Used by the framework during HTTP request startup to determine the requested domain. For internal framework use only. |
| GetTimeZoneInfo | (not specified) |
| GetType | Gets the Type of the current instance. |
| GetUrlArg | Used to retrieve URL query string arguments (outside of a controller). |
| GetUserLanguage | (not specified) |
| Init | Called during application startup to save some environmental information. For internal framework use only. |
| IsSync | Returns whether requests must be made synchronously (i.e., no async). |
| MakeInitialThreadInstance | Attaches a YetaWFManager instance to the current thread. For internal framework use only. This is only used by console applications. |
| MakeInstance | Creates an instance of the YetaWFManager class for a site. For internal framework use only. This is only used by the framework during request startup as soon as the site URL has been determined. |
| MakeThreadInstance | Creates an instance of the YetaWFManager - used for non-site specific threads (e.g., scheduler). For internal framework use only. Can only be used once MakeInitialThreadInstance has been used. |
| MemberwiseClone | Creates a shallow copy of the current Object. |
| NeedUser | (not specified) |
| NextUniqueIdPrefix | (not specified) |
| PageCss | Adds the page's or popup's css classes (the current edit mode, the current page's defined css and other page css). |
| ReferenceEquals | Determines whether the specified Object instances are the same instance. |
| RemoveThreadInstance | Removes the YetaWF instance from the current thread. For internal framework use only. |
| RestartSite | (not specified) |
| SetPackageData | Saves data for a package. The saved data is only available during the current HTTP request. |
| SetStaticCacheInfo | (not specified) |
| SetSuperUserRole | (not specified) |
| SetUserLanguageAsync | (not specified) |
| StartNestedComponent | (not specified) |
| Syncify | Runs synchronously and returns the return value of the async body within its scope. |
| ToString | Returns a string that represents the current object. |
| TryGetUrlArg | Used to retrieve URL query string arguments (outside of a controller). |
| UniqueId | Returns a unique HTML id. |
 | DeviceSelected | The selected rendering mode for this site |
See Also YetaWF.Core Overview
Documentation Feedback
© 2024 - Softel vdm, Inc. - YetaWF.com