[This is preliminary documentation and is subject to change.]
The TemplateHandler type exposes the following members.Constructors
Name | Description | |
---|---|---|
![]() | TemplateHandler(WorkDispatcher, IConfigSectionNode) | Initializes a new instance of the TemplateHandler class |
![]() | TemplateHandler(WorkDispatcher, String, Int32, WorkMatch) | Initializes a new instance of the TemplateHandler class |
Methods
Name | Description | |
---|---|---|
![]() | ___setParentHandler | (Inherited from WorkHandler.) |
![]() | __setComponentDirector | (Inherited from ApplicationComponent.) |
![]() | CreateTargetInstance |
Factory method - Override to create and init more particular template implementation (i.e. based on model)
(Inherited from TypeLookupHandler TTarget .) |
![]() | DeleteTargetInstanceByID |
Deletes target instance with id from store. Default implementation uses Application.ObjectStore.
(Inherited from TypeLookupHandler TTarget .) |
![]() | Destructor | (Inherited from WorkHandler.) |
![]() | Dispose |
Deterministically disposes object. DO NOT OVERRIDE this method, override Destructor() instead
(Inherited from DisposableObject.) |
![]() | Do404 |
Override to handle 404 condition, i.e. may write into response instead of generating a exception.
The default implementation returns a HttpStatusException with 404 code
(Inherited from TypeLookupHandler TTarget .) |
![]() | DoError |
Override to handle error processing, i.e. may elect to write error data into response.
The dafault implementation throws the error. It is recommended to handle errors with filters instead
(Inherited from TypeLookupHandler TTarget .) |
![]() | DoHandleWork |
Sealed. Override DoTargetWork(TTarget, WorkContext) to do actual work
(Inherited from TypeLookupHandler TTarget .) |
![]() | DoTargetWork | (Overrides TypeLookupHandler TTarget DoTargetWork(TTarget, WorkContext).) |
![]() | EnsureObjectNotDisposed |
Checks to see whether object dispose started or has already been disposed and throws an exception if Dispose() was called
(Inherited from DisposableObject.) |
![]() | ![]() | Determines whether the specified object is equal to the current object. (Inherited from ![]() |
![]() | FilterAndHandleWork |
Handles the work - first involes all filters then calls HandleWork to do actual processing
Note: This method is re-entrant by multiple threads
(Inherited from WorkHandler.) |
![]() | Finalize | (Inherited from DisposableObject.) |
![]() | ![]() | Serves as the default hash function. (Inherited from ![]() |
![]() | GetTargetInstanceByID |
Retrieves target instance from id. Default implementation uses Application.ObjectStore.
If this method is called by the framework then complementary matching PutTargetInstanceWithID() is guaranteed to be called as well
(Inherited from TypeLookupHandler TTarget .) |
![]() | GetTargetInstanceID |
Override to extract instance ID from WorkContext
(Inherited from TypeLookupHandler TTarget .) |
![]() | GetTargetType |
Override to resolve route/URL parameters to type
(Inherited from TypeLookupHandler TTarget .) |
![]() | GetTargetTypeNameFromWorkContext |
Override to get type name from WorkContext. Default implementation looks for MatchedVars[VAR_TARGET_TYPE]
(Inherited from TypeLookupHandler TTarget .) |
![]() | ![]() | Gets the (Inherited from ![]() ![]() |
![]() | HandleWork |
Handles the work - i.e. renders a template page or calls MVC controller method.
This method does not pass through handler's filters
Note: This method is re-entrant by multiple threads
(Inherited from WorkHandler.) |
![]() | MakeMatch |
Returns true when the particular work request matches the pattern match of this handler.
Also sets the WorkHandler's MatchedVars property filled with matched values
(Inherited from WorkHandler.) |
![]() | ![]() | Creates a shallow copy of the current (Inherited from ![]() ![]() |
![]() | PutTargetInstanceByID |
Puts target instance with id into store. Default implementation uses Application.ObjectStore.
This method is called by the framework to complement GetTargetInstanceFromID()
(Inherited from TypeLookupHandler TTarget .) |
![]() | RegisterFilter |
Registers filter and returns true if the named instance has not been registered yet
Note: it is possible to call this method on active server that is - inject filters while serving requests
(Inherited from WorkHandler.) |
![]() | ToString | (Inherited from WorkHandler.) |
![]() | UnRegisterFilter |
Unregisters filter and returns true if the named instance has been removed
Note: it is possible to call this method on active server that is - remove filters while serving requests
(Inherited from WorkHandler.) |
Extension Methods
Properties
Name | Description | |
---|---|---|
![]() | CloakTypeName |
Provides type name which is used if the prior one was not found. This allows to block 404 errors,
i.e. if page with requested name is not found then always return the specified page
(Inherited from TypeLookupHandler TTarget .) |
![]() | ComponentCommonName |
Returns the common name used to identify the component, for example "Glue" for various IGlue implementations.
This name is searched-by some management tools that allow to find component by this name that does not change between
application restarts like ComponentSID does. Subordinate (non-root) components return null
(Inherited from ApplicationComponent.) |
![]() | ComponentDirector |
Returns a reference to an object that this app component services/operates under, or null
(Inherited from ApplicationComponent.) |
![]() | ComponentSID |
Returns process/instance unique app component system id
(Inherited from ApplicationComponent.) |
![]() | ComponentStartTime |
Returns local computer time of component start (not from application container time)
(Inherited from ApplicationComponent.) |
![]() | DefaultTypeName |
Provides default type name
(Inherited from TypeLookupHandler TTarget .) |
![]() | Dispatcher |
Returns the dispatcher that this handler works under
(Inherited from WorkHandler.) |
![]() | Disposed |
Indicates whether this object was already disposed - the Dispose() has finished
(Inherited from DisposableObject.) |
![]() | DisposeStarted |
Indicates whether this object Dispose() has been called and dispose started but not finished yet
(Inherited from DisposableObject.) |
![]() | Filters |
Returns ordered registry of filters
(Inherited from WorkHandler.) |
![]() | Matches |
Returns matches used by this handler. May change the registry at runtime (inject/remove matches)
(Inherited from WorkHandler.) |
![]() | Name |
Returns the handler instance name
(Inherited from WorkHandler.) |
![]() | NetGate |
Returns network gate that handler implementation may use to set business variables or null
(Inherited from WorkHandler.) |
![]() | NotFoundRedirectURL |
Provides redirect URL where the user gets redirected when type name could not be resolved.
Note: CloakTypeName is used first when set.
(Inherited from TypeLookupHandler TTarget .) |
![]() | Order |
Returns the handler order in handler registry. Order is used for URI pattern matching
(Inherited from WorkHandler.) |
![]() | ParentHandler |
Returns parent handler that this handler is under or null
(Inherited from WorkHandler.) |
![]() | Server |
Returns the server that this handler works under
(Inherited from WorkHandler.) |
![]() | SupportsInstanceID |
Indicates whether instance IDs are supported in requests. Default is false.
Override to return true for handlers that support target instance state between requests
(Inherited from TypeLookupHandler TTarget .) |
![]() | TypeLocations |
Returns a registry of type locations
(Inherited from TypeLookupHandler TTarget .) |
See Also