Click or drag to resize

PFItemControllerPFItemType Class

Provides methods executing actions during PFItem MVC cycles.
Inheritance Hierarchy
SystemObject
  ControllerBase
    Controller
      Packflow.InterfacePFItemController
        Packflow.InterfacePFItemControllerPFItemType

Namespace:  Packflow.Interface
Assembly:  MicaSystems.Packflow.Interface (in MicaSystems.Packflow.Interface.dll) Version: 1.0.0.0 (2.0.0.223)
Syntax
C#
public abstract class PFItemController<PFItemType> : PFItemController
where PFItemType : PFItem

Type Parameters

PFItemType

The PFItemControllerPFItemType type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyActionInvoker (Inherited from Controller.)
Public propertyAsyncManager (Inherited from Controller.)
Protected propertyBinders (Inherited from Controller.)
Public propertyControllerContext (Inherited from ControllerBase.)
Protected propertyDisableAsyncSupport (Inherited from Controller.)
Public propertyHttpContext (Inherited from Controller.)
Public propertyModelState (Inherited from Controller.)
Public propertyProfile (Inherited from Controller.)
Public propertyRequest (Inherited from Controller.)
Public propertyResolver (Inherited from Controller.)
Public propertyResponse (Inherited from Controller.)
Public propertyRouteData (Inherited from Controller.)
Public propertyServer (Inherited from Controller.)
Public propertySession (Inherited from Controller.)
Protected propertySourceUrl
Gets the source url of the current request.
Public propertyTempData (Inherited from ControllerBase.)
Public propertyTempDataProvider (Inherited from Controller.)
Public propertyUrl (Inherited from Controller.)
Public propertyUser (Inherited from Controller.)
Public propertyValidateRequest (Inherited from ControllerBase.)
Public propertyValueProvider (Inherited from ControllerBase.)
Public propertyViewBag (Inherited from ControllerBase.)
Public propertyViewData (Inherited from ControllerBase.)
Public propertyViewEngineCollection (Inherited from Controller.)
Top
Methods
  NameDescription
Protected methodApplyFormsRestriction
Applies the forms restriction (for the current user) from application settings. If the restriction is not respected, an access denied exception is thrown. Else the level of accessibility is returned.
Protected methodBeginExecute (Inherited from Controller.)
Protected methodBeginExecuteCore (Inherited from Controller.)
Public methodChangeContext
Administration action. Changes the application context of the current item.
Public methodClose
Action called when the "Close" button is clicked.
Protected methodContent(String) (Inherited from Controller.)
Protected methodContent(String, String) (Inherited from Controller.)
Protected methodContent(String, String, Encoding) (Inherited from Controller.)
Protected methodCreateActionInvoker (Inherited from Controller.)
Protected methodCreateTempDataProvider (Inherited from Controller.)
Public methodDefault
Default action, called when the page is called without postback.
Public methodDeleteItem
Action called when the button "Delete this item" (under the "Other actions" menu) is clicked.
Public methodDispose (Inherited from Controller.)
Protected methodDispose(Boolean) (Inherited from Controller.)
Public methodDownloadTemplateDataSet
Administration action. Download a dataset for WordForm, centered on the current item.
Public methodEditItem
Action called when the button "Edit item" is clicked.
Protected methodEndExecute (Inherited from Controller.)
Protected methodEndExecuteCore (Inherited from Controller.)
Protected methodEnsureLock
Ensures that the current user has an active lock, if possible.

If the lock already exists, the validity is reset.

Protected methodExecute (Inherited from ControllerBase.)
Protected methodExecuteCore (Inherited from Controller.)
Protected methodFile(Byte, String) (Inherited from Controller.)
Protected methodFile(Stream, String) (Inherited from Controller.)
Protected methodFile(String, String) (Inherited from Controller.)
Protected methodFile(Byte, String, String) (Inherited from Controller.)
Protected methodFile(Stream, String, String) (Inherited from Controller.)
Protected methodFile(String, String, String) (Inherited from Controller.)
Public methodFinishTask
Action called when the "Finish task" is clicked.
Public methodForceTransition
Administration action. Forces a specific transition for the current item's workflow.
Public methodForceUnlock
Administration action. Forces the current user to release its lock on the current item.
Protected methodGetCurrentLock
Tries to find lock for current user on item.
Protected methodGetDefaultViewResult
Returns the standard view result for an item.
(Inherited from PFItemController.)
Protected methodGetFormGridviewViewPath
Gets the relative path of a gridview action page.
Protected methodGetFormViewPath
Returns the relative path of the page for an item.
(Inherited from PFItemController.)
Protected methodGetRelation
Gets the contextual relation (generally in gridviews).

Throw an exception if the relation does not exist in both models.

Return null if no relation name is found in the form collection.

Protected methodGetWorkflowNewStepMessage
Generates the translated message shown to the user when a new step is reached in an item's workflow.
Public methodGridview_CancelLine
Action called when an inline creation or edition is canceled in a gridview.
Public methodGridview_DeleteLine
Action called when an item is deleted from a gridview.
Public methodGridview_DuplicateLine
[NOT CURRENTLY USED] Action called when an inline duplication is initiated in a gridview.
Public methodGridview_EditLine
Action called when an inline edition is initiated in a gridview.
Protected methodGridview_GetParentItem
Returns the source (related) item of the current item (in a gridview context).
Public methodGridview_LoadRow
Action called when a gridview row needs to be refreshed.
Public methodGridview_NewLine
Action called when an inline creation is initiated in a gridview.
Public methodGridview_SaveLine
Action called when an (new or existing) item is saved in a gridview.
Public methodGridview_UnlinkLine
Action called when an item is unlinked from a gridview based on a source item relation.
Protected methodHandleUnknownAction (Inherited from Controller.)
Protected methodHttpNotFound (Inherited from Controller.)
Protected methodHttpNotFound(String) (Inherited from Controller.)
Protected methodInitialize (Inherited from Controller.)
Protected methodJavaScript (Inherited from Controller.)
Protected methodJson(Object) (Inherited from Controller.)
Protected methodJson(Object, String) (Inherited from Controller.)
Protected methodJson(Object, JsonRequestBehavior) (Inherited from Controller.)
Protected methodJson(Object, String, Encoding) (Inherited from Controller.)
Protected methodJson(Object, String, JsonRequestBehavior) (Inherited from Controller.)
Protected methodJson(Object, String, Encoding, JsonRequestBehavior) (Inherited from Controller.)
Public methodNextStep
Action called when the button "Next step" is clicked.
Protected methodNotifySourceGridViewForUpdate
Notifies the source gridview that an update is available. The gridview will then refresh if no inline edition is in progress.

Do not use during inline actions, it would be useless.

Currently used when items are created with the "Tab" creation mode of the gridview.

Note: only works if the parameter SourceGridViewId is available in the query string.

Protected methodNotifyuserGridViewsForItemUpdate
Notifies the user's listening pages that an update is available for the given item. The gridviews will then refresh the corresponding rows.

Currently used when items are opened with the "Tab".

Protected methodOnActionExecuted (Inherited from Controller.)
Protected methodOnActionExecuting (Inherited from Controller.)
Protected methodOnAuthentication (Inherited from Controller.)
Protected methodOnAuthenticationChallenge (Inherited from Controller.)
Protected methodOnAuthorization (Inherited from Controller.)
Protected methodOnException (Inherited from Controller.)
Protected methodOnResultExecuted (Inherited from Controller.)
Protected methodOnResultExecuting (Inherited from Controller.)
Protected methodPartialView (Inherited from Controller.)
Protected methodPartialView(Object) (Inherited from Controller.)
Protected methodPartialView(String) (Inherited from Controller.)
Protected methodPartialView(String, Object) (Inherited from Controller.)
Public methodReassignTask
Administration action. Reassigns a given task to a chosen user.
Protected methodRedirect (Inherited from Controller.)
Protected methodRedirectPermanent (Inherited from Controller.)
Protected methodRedirectToAction(String) (Inherited from Controller.)
Protected methodRedirectToAction(String, Object) (Inherited from Controller.)
Protected methodRedirectToAction(String, RouteValueDictionary) (Inherited from Controller.)
Protected methodRedirectToAction(String, String) (Inherited from Controller.)
Protected methodRedirectToAction(String, String, Object) (Inherited from Controller.)
Protected methodRedirectToAction(String, String, RouteValueDictionary) (Inherited from Controller.)
Protected methodRedirectToActionPermanent(String) (Inherited from Controller.)
Protected methodRedirectToActionPermanent(String, Object) (Inherited from Controller.)
Protected methodRedirectToActionPermanent(String, RouteValueDictionary) (Inherited from Controller.)
Protected methodRedirectToActionPermanent(String, String) (Inherited from Controller.)
Protected methodRedirectToActionPermanent(String, String, Object) (Inherited from Controller.)
Protected methodRedirectToActionPermanent(String, String, RouteValueDictionary) (Inherited from Controller.)
Protected methodRedirectToRoute(Object) (Inherited from Controller.)
Protected methodRedirectToRoute(RouteValueDictionary) (Inherited from Controller.)
Protected methodRedirectToRoute(String) (Inherited from Controller.)
Protected methodRedirectToRoute(String, Object) (Inherited from Controller.)
Protected methodRedirectToRoute(String, RouteValueDictionary) (Inherited from Controller.)
Protected methodRedirectToRoutePermanent(Object) (Inherited from Controller.)
Protected methodRedirectToRoutePermanent(RouteValueDictionary) (Inherited from Controller.)
Protected methodRedirectToRoutePermanent(String) (Inherited from Controller.)
Protected methodRedirectToRoutePermanent(String, Object) (Inherited from Controller.)
Protected methodRedirectToRoutePermanent(String, RouteValueDictionary) (Inherited from Controller.)
Public methodRefresh
Action called to refresh the page.
Protected methodReleaseLock
Tries to release lock for current user on item.
Public methodReplaceActor
Administration action. Reassigns a given task to the current user (if allowed to).
Public methodSaveItem
Action called when the button "Save" is clicked.
Public methodSaveItemAndClose
Action called when the button "Save and close" is clicked.
Public methodSynchronizeWithExternalSource
Action called to update the item's data from its synchronized source (using the external connection).
Public methodToggleUnlimitedModification
Action called to enable or disable unlimited modification mode.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Protected methodTriggerApplicationEvent
Triggers an application event for a custom action. The event PFApplicationEvents.ControllerEvent_CustomAction is broadcasted to all applications.
Protected methodTryGetLock
Tries to get(create) lock for current user on item.
Protected methodTryGetParentItem
Returns the source (related) item of the current item.

Uses the gridview context if any.

Uses the query string if the current object is being created from the source object.

Protected methodTryUpdateModel``1(UMP) (Inherited from Controller.)
Protected methodTryUpdateModel``1(UMP, String) (Inherited from Controller.)
Protected methodTryUpdateModel``1(UMP, String) (Inherited from Controller.)
Protected methodTryUpdateModel``1(UMP, IValueProvider) (Inherited from Controller.)
Protected methodTryUpdateModel``1(UMP, String, String) (Inherited from Controller.)
Protected methodTryUpdateModel``1(UMP, String, IValueProvider) (Inherited from Controller.)
Protected methodTryUpdateModel``1(UMP, String, IValueProvider) (Inherited from Controller.)
Protected methodTryUpdateModel``1(UMP, String, String, String) (Inherited from Controller.)
Protected methodTryUpdateModel``1(UMP, String, String, IValueProvider) (Inherited from Controller.)
Protected methodTryUpdateModel``1(UMP, String, String, String, IValueProvider) (Inherited from Controller.)
Protected methodTryValidateModel(Object) (Inherited from Controller.)
Protected methodTryValidateModel(Object, String) (Inherited from Controller.)
Protected methodUpdateModel``1(UMP) (Inherited from Controller.)
Protected methodUpdateModel``1(UMP, String) (Inherited from Controller.)
Protected methodUpdateModel``1(UMP, String) (Inherited from Controller.)
Protected methodUpdateModel``1(UMP, IValueProvider) (Inherited from Controller.)
Protected methodUpdateModel``1(UMP, String, String) (Inherited from Controller.)
Protected methodUpdateModel``1(UMP, String, IValueProvider) (Inherited from Controller.)
Protected methodUpdateModel``1(UMP, String, IValueProvider) (Inherited from Controller.)
Protected methodUpdateModel``1(UMP, String, String, String) (Inherited from Controller.)
Protected methodUpdateModel``1(UMP, String, String, IValueProvider) (Inherited from Controller.)
Protected methodUpdateModel``1(UMP, String, String, String, IValueProvider) (Inherited from Controller.)
Public methodUpdatePermissions
Administration action. Forces a recalculation of the permissions of the current item.

This can be useful when rules changed (in the model) since the last save.

Protected methodValidateModel(Object) (Inherited from Controller.)
Protected methodValidateModel(Object, String) (Inherited from Controller.)
Protected methodView (Inherited from Controller.)
Protected methodView(Object) (Inherited from Controller.)
Protected methodView(String) (Inherited from Controller.)
Protected methodView(IView) (Inherited from Controller.)
Protected methodView(String, String) (Inherited from Controller.)
Protected methodView(String, Object) (Inherited from Controller.)
Protected methodView(IView, Object) (Inherited from Controller.)
Protected methodView(String, String, Object)
Standard method called by MVC at the end of all controllers' actions.

This method is overridden to handle the AutoStartTask option.

If the option is activated, this will ensure a lock and set the current task as active, if possible.

In general, avoid to call or override this method.

(Overrides Controller.View(String, String, Object).)
Top
Extension Methods
  NameDescription
Public Extension MethodAsT
Casts an object to another type. Returns default(T) if the object is null.
(Defined by Utils_Other.)
Public Extension MethodEqualsAll
Checks that this object is equal to every object in parameters.
(Defined by Utils_Other.)
Public Extension MethodEqualsAny
Checks that this object is equal to at least one of the parameters.
(Defined by Utils_Other.)
Public Extension MethodGetString
Converts an object to String using ToString() method, else returns String.Empty.
(Defined by Utils_Other.)
Public Extension MethodIsGenericListOverloaded.
Checks if this object is a System.Collections.Generic.List.
(Defined by Utils_Linq.)
Public Extension MethodIsGenericList(Type)Overloaded.
Checks if this object is a System.Collections.Generic.List using type as T.
(Defined by Utils_Linq.)
Public Extension MethodSerializeOverloaded.
Serializes an object into an XML document.
(Defined by Utils_Xml.)
Public Extension MethodSerialize(String)Overloaded.
Serializes an object into an XML document.
(Defined by Utils_Xml.)
Public Extension MethodSerializeJsonOverloaded.
Serializes an object using a DataContractJsonSerializer.
(Defined by Utils_String.)
Public Extension MethodSerializeJson(ListType)Overloaded.
Serializes an object using a DataContractJsonSerializer.
(Defined by Utils_String.)
Public Extension MethodSerializeJson(DataContractJsonSerializerSettings)Overloaded.
Serializes an object using a DataContractJsonSerializer.
(Defined by Utils_String.)
Top
See Also