TemplateHandler MembersNFX Class Library

[This is preliminary documentation and is subject to change.]

The TemplateHandler type exposes the following members.
Constructors

  NameDescription
Protected methodTemplateHandler(WorkDispatcher, IConfigSectionNode)
Initializes a new instance of the TemplateHandler class
Protected methodTemplateHandler(WorkDispatcher, String, Int32, WorkMatch)
Initializes a new instance of the TemplateHandler class
Back to Top
Methods

  NameDescription
Protected method___setParentHandler (Inherited from WorkHandler.)
Protected method__setComponentDirector (Inherited from ApplicationComponent.)
Protected methodCreateTargetInstance
Factory method - Override to create and init more particular template implementation (i.e. based on model)
(Inherited from TypeLookupHandler TTarget .)
Protected methodDeleteTargetInstanceByID
Deletes target instance with id from store. Default implementation uses Application.ObjectStore.
(Inherited from TypeLookupHandler TTarget .)
Protected methodDestructor (Inherited from WorkHandler.)
Public methodDispose
Deterministically disposes object. DO NOT OVERRIDE this method, override Destructor() instead
(Inherited from DisposableObject.)
Protected methodDo404
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 .)
Protected methodDoError
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 .)
Protected methodDoHandleWork
Sealed. Override DoTargetWork(TTarget, WorkContext) to do actual work
(Inherited from TypeLookupHandler TTarget .)
Protected methodDoTargetWork (Overrides TypeLookupHandler TTarget  DoTargetWork(TTarget, WorkContext).)
Public methodEnsureObjectNotDisposed
Checks to see whether object dispose started or has already been disposed and throws an exception if Dispose() was called
(Inherited from DisposableObject.)
Public methodOnlineEquals
Determines whether the specified object is equal to the current object.
(Inherited from OnlineObject.)
Public methodFilterAndHandleWork
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.)
Protected methodFinalize (Inherited from DisposableObject.)
Public methodOnlineGetHashCode
Serves as the default hash function.
(Inherited from OnlineObject.)
Protected methodGetTargetInstanceByID
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 .)
Protected methodGetTargetInstanceID
Override to extract instance ID from WorkContext
(Inherited from TypeLookupHandler TTarget .)
Protected methodGetTargetType
Override to resolve route/URL parameters to type
(Inherited from TypeLookupHandler TTarget .)
Protected methodGetTargetTypeNameFromWorkContext
Override to get type name from WorkContext. Default implementation looks for MatchedVars[VAR_TARGET_TYPE]
(Inherited from TypeLookupHandler TTarget .)
Public methodOnlineGetType
Gets the OnlineType of the current instance.
(Inherited from OnlineObject.)
Public methodHandleWork
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.)
Public methodMakeMatch
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.)
Protected methodOnlineMemberwiseClone
Creates a shallow copy of the current OnlineObject.
(Inherited from OnlineObject.)
Protected methodPutTargetInstanceByID
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 .)
Public methodRegisterFilter
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.)
Public methodToString (Inherited from WorkHandler.)
Public methodUnRegisterFilter
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.)
Back to Top
Extension Methods

  NameDescription
Public Extension MethodAsBool (Defined by ObjectValueConversion.)
Public Extension MethodAsByte (Defined by ObjectValueConversion.)
Public Extension MethodAsChar (Defined by ObjectValueConversion.)
Public Extension MethodAsDateTime Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsDateTime(DateTime, ConvertErrorHandling)Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsDecimal (Defined by ObjectValueConversion.)
Public Extension MethodAsDouble (Defined by ObjectValueConversion.)
Public Extension MethodAsEnum TEnum  (Defined by ObjectValueConversion.)
Public Extension MethodAsFloat (Defined by ObjectValueConversion.)
Public Extension MethodAsGDID Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsGDID(GDID, ConvertErrorHandling)Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsGDIDSymbol Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsGDIDSymbol(GDIDSymbol, ConvertErrorHandling)Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsGUID (Defined by ObjectValueConversion.)
Public Extension MethodAsInt (Defined by ObjectValueConversion.)
Public Extension MethodAsJSONConfig (Defined by ObjectValueConversion.)
Public Extension MethodAsLaconicConfig (Defined by ObjectValueConversion.)
Public Extension MethodAsLong (Defined by ObjectValueConversion.)
Public Extension MethodAsNonNullOrEmptyString (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableBool (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableByte (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableChar (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableDateTime (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableDecimal (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableDouble (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableEnum TEnum  (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableFloat (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableGDID (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableGDIDSymbol (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableGUID (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableInt (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableLong (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableSByte (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableShort (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableTimeSpan (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableUInt (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableULong (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableUShort (Defined by ObjectValueConversion.)
Public Extension MethodAsSByte (Defined by ObjectValueConversion.)
Public Extension MethodAsShort (Defined by ObjectValueConversion.)
Public Extension MethodAsString (Defined by ObjectValueConversion.)
Public Extension MethodAsTimeSpan Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsTimeSpan(TimeSpan, ConvertErrorHandling)Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsUInt (Defined by ObjectValueConversion.)
Public Extension MethodAsULong (Defined by ObjectValueConversion.)
Public Extension MethodAsUri (Defined by ObjectValueConversion.)
Public Extension MethodAsUShort (Defined by ObjectValueConversion.)
Public Extension MethodAsXMLConfig (Defined by ObjectValueConversion.)
Public Extension MethodToErlObject Overloaded.
Try to convert .NET native object type to corresponding Erlang term. Throw exception if conversion is not possible
(Defined by ErlObject.)
Public Extension MethodToErlObject(ErlTypeOrder, Boolean)Overloaded.
Try to convert .NET native object type to corresponding Erlang term of given type. Throw exception if conversion is not possible
(Defined by ErlObject.)
Public Extension MethodToJSON(JSONWritingOptions)Overloaded.
Serializes object into JSON string
(Defined by JSONExtensions.)
Public Extension MethodToJSON(TextWriter, JSONWritingOptions)Overloaded.
Serializes object into JSON format using provided TextWriter
(Defined by JSONExtensions.)
Public Extension MethodToJSON(Stream, JSONWritingOptions, Encoding)Overloaded.
Serializes object into JSON format using provided stream and optional encoding
(Defined by JSONExtensions.)
Back to Top
Properties

  NameDescription
Public propertyCloakTypeName
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 .)
Public propertyComponentCommonName
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.)
Public propertyComponentDirector
Returns a reference to an object that this app component services/operates under, or null
(Inherited from ApplicationComponent.)
Public propertyComponentSID
Returns process/instance unique app component system id
(Inherited from ApplicationComponent.)
Public propertyComponentStartTime
Returns local computer time of component start (not from application container time)
(Inherited from ApplicationComponent.)
Public propertyDefaultTypeName
Provides default type name
(Inherited from TypeLookupHandler TTarget .)
Public propertyDispatcher
Returns the dispatcher that this handler works under
(Inherited from WorkHandler.)
Public propertyDisposed
Indicates whether this object was already disposed - the Dispose() has finished
(Inherited from DisposableObject.)
Public propertyDisposeStarted
Indicates whether this object Dispose() has been called and dispose started but not finished yet
(Inherited from DisposableObject.)
Public propertyFilters
Returns ordered registry of filters
(Inherited from WorkHandler.)
Public propertyMatches
Returns matches used by this handler. May change the registry at runtime (inject/remove matches)
(Inherited from WorkHandler.)
Public propertyName
Returns the handler instance name
(Inherited from WorkHandler.)
Public propertyNetGate
Returns network gate that handler implementation may use to set business variables or null
(Inherited from WorkHandler.)
Public propertyNotFoundRedirectURL
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 .)
Public propertyOrder
Returns the handler order in handler registry. Order is used for URI pattern matching
(Inherited from WorkHandler.)
Public propertyParentHandler
Returns parent handler that this handler is under or null
(Inherited from WorkHandler.)
Public propertyServer
Returns the server that this handler works under
(Inherited from WorkHandler.)
Public propertySupportsInstanceID
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 .)
Public propertyTypeLocations
Returns a registry of type locations
(Inherited from TypeLookupHandler TTarget .)
Back to Top
See Also