PFItemHtmlHelperPFItemType Class |
Provides all tools to generate forms, controls and displays of a PFItem of type PFItemType.
Inheritance HierarchySystemObject
HtmlHelper
Packflow.InterfacePFItemHtmlHelper
Packflow.InterfacePFItemHtmlHelperPFItemType
HtmlHelper
Packflow.InterfacePFItemHtmlHelper
Packflow.InterfacePFItemHtmlHelperPFItemType
Namespace: Packflow.Interface
Assembly: MicaSystems.Packflow.Interface (in MicaSystems.Packflow.Interface.dll) Version: 1.0.0.0 (2.0.0.223)
SyntaxC#
public class PFItemHtmlHelper<PFItemType> : PFItemHtmlHelper where PFItemType : PFItem
Type Parameters
- PFItemType
- The specific type of PFItem.
The PFItemHtmlHelperPFItemType type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | PFItemHtmlHelperPFItemType |
Initializes a new instance of the PFItemHtmlHelper class.
|
Properties| Name | Description | |
|---|---|---|
 | BodyOnly | Gets a value indicating whether only the content of the body should be generated. If true, only dynamic parts of the form are generated (actions, sections, version number, ...). |
 | CurrentApplication |
Gets the current application.
(Inherited from PFItemHtmlHelper.) |
| CurrentContentType |
Gets the current content type.
(Inherited from PFItemHtmlHelper.) |
| CurrentItem |
Gets the current item.
(Inherited from PFItemHtmlHelper.) |
| CurrentModel |
Gets the current application's model.
(Inherited from PFItemHtmlHelper.) |
| CurrentModelContentType |
Gets the current content-type definition from the current model.
(Inherited from PFItemHtmlHelper.) |
| CurrentModelForm |
Gets the current Form definition from the current model.
(Inherited from PFItemHtmlHelper.) |
| CurrentObject |
Gets the current item, strongly typed.
|
| CurrentSite |
Gets the current site.
(Inherited from PFItemHtmlHelper.) |
| CurrentUser |
Gets the current user.
(Inherited from PFItemHtmlHelper.) |
| EnableEditableControls |
Gets or sets a value indicating whether the controls can be editable or not.
(Inherited from PFItemHtmlHelper.)If set to false, editable controls will be generated disabled. |
| EnableFullJQueryUIReference |
Gets a value indicating whether all JQuery UI plugins should be included,
or just the ones required by Packflow.
(Inherited from PFItemHtmlHelper.)False by default. |
| EnableFullKendoReference |
Gets a value indicating whether all Kendo UI plugins should be included
or just the ones required by Packflow.
(Inherited from PFItemHtmlHelper.)False by default. |
| Focus |
Gets the default focus information.
(Inherited from PFItemHtmlHelper.)Contains the mode (Default or Admin) and the section id separated by ";". |
| Html5DateRenderingMode | (Inherited from HtmlHelper.) |
| LoadedVersion |
Gets the loaded version.
(Inherited from PFItemHtmlHelper.)Will be the version number of the current item after a GET request or an item save. In other POST requests, the version is obtained from the page. |
| Logger |
Gets the logger (CurrentItem's logger is used).
(Inherited from PFItemHtmlHelper.) |
| PageContext |
Gets the page context.
(Inherited from PFItemHtmlHelper.) |
| RouteCollection | (Inherited from HtmlHelper.) |
| ShowFieldsInternalNames |
Gets a value indicating whether fields' internal names are shown in labels.
(Inherited from PFItemHtmlHelper.)The result is based on the presence of "sfin=true" in the query string. |
| SourceRelationGuid |
Gets the source relation GUID. If not relevant, returns Guid.empty.
(Inherited from PFItemHtmlHelper.) |
| Translations |
Gets the contextual translations provided by Packflow.
(Inherited from PFItemHtmlHelper.) |
| ViewBag | (Inherited from HtmlHelper.) |
| ViewContext | (Inherited from HtmlHelper.) |
| ViewData | (Inherited from HtmlHelper.) |
| ViewDataContainer | (Inherited from HtmlHelper.) |
Methods| Name | Description | |
|---|---|---|
| AntiForgeryToken | (Inherited from HtmlHelper.) |
| AntiForgeryToken(String) | Obsolete. (Inherited from HtmlHelper.) |
| AntiForgeryToken(String, String, String) | Obsolete. (Inherited from HtmlHelper.) |
| AttributeEncode(String) | (Inherited from HtmlHelper.) |
| AttributeEncode(Object) | (Inherited from HtmlHelper.) |
| BeginPackflowForm |
Returns an opening form tag and sets controller and action information.
The form uses the specified HTTP method and includes the HTML attributes from a dictionary.
(Inherited from PFItemHtmlHelper.) |
| ControlForTProperty |
Gets the html of a PFField control, loaded with current item corresponding value.
This method is called from generated ASPX forms. From CSharp, you can call directly the GetControlHtml method. |
| CustomizeActions |
Override this method to customize, add or remove actions from the actions bar.
(Inherited from PFItemHtmlHelper.) |
| CustomizeGridViewSettings |
Customizes the settings of a given gridview.
(Inherited from PFItemHtmlHelper.) |
| DisplayForTProperty |
Gets the display html of a PFField, loaded with current item corresponding value.
This method is called from generated ASPX forms. From CSharp, you can call directly the GetDisplayHtml method. |
| EnableClientValidation | (Inherited from HtmlHelper.) |
| EnableClientValidation(Boolean) | (Inherited from HtmlHelper.) |
| EnableGridViewCheckboxes |
Determines if the checkboxes are enabled in the gridview with the specified name.
(Inherited from PFItemHtmlHelper.)By default, returns false. |
| EnableUnobtrusiveJavaScript | (Inherited from HtmlHelper.) |
| EnableUnobtrusiveJavaScript(Boolean) | (Inherited from HtmlHelper.) |
| Encode(String) | (Inherited from HtmlHelper.) |
| Encode(Object) | (Inherited from HtmlHelper.) |
| FormatValue | (Inherited from HtmlHelper.) |
| GetAllFieldControlMode |
Gets the control mode of all field.
(Inherited from PFItemHtmlHelper.) |
| GetButton |
Gets the button with the specified guid.
(Inherited from PFItemHtmlHelper.) |
 | GetButtonConfirmationMessage |
Gets the confirmation message of a given button.
(Inherited from PFItemHtmlHelper.)By default, depends on the model. No confirmation dialog is shown if the text is empty. |
| GetButtonContent |
Gets the caption of a given button.
(Inherited from PFItemHtmlHelper.) |
| GetButtonHtml |
Gets the html of a given button.
(Inherited from PFItemHtmlHelper.) |
| GetButtonMode |
Gets the control mode of a button.
(Inherited from PFItemHtmlHelper.)By default, depends on page mode, button settings and the current state settings. |
| GetButtonObject |
Gets a button definition by its guid.
(Inherited from PFItemHtmlHelper.) |
| GetCaption |
Gets the html displayed in the caption of the actions bar.
(Inherited from PFItemHtmlHelper.) |
| GetControlHtml(PFField, Object) |
Gets the html of a PFField control, loaded with the specified value.
(Inherited from PFItemHtmlHelper.) |
| GetControlHtml(PFField, PFFieldControlMode, Object) |
Gets the html of a PFField control in a specific mode, loaded with the specified value.
(Inherited from PFItemHtmlHelper.) |
| GetCustomCaptionIconLetters |
Gets the custom icon letters for the actions bar caption.
(Inherited from PFItemHtmlHelper.) |
| GetCustomFiltersForChoicePossibleItems |
Gets the custom filters for a choice field, mixed with the filters of the view.
(Inherited from PFItemHtmlHelper.)The result is used to refine the list of selectable values of a PFFieldChoice. By default, returns null. |
| GetDefaultSection |
Gets the id of the section focused by default (by scrolling or the default selected tab).
(Inherited from PFItemHtmlHelper.)The default value is retrieved from the current item's state. |
| GetDisplayHtml(PFField, String) |
Gets the display HTML representing a value of a PFField.
(Inherited from PFItemHtmlHelper.) |
| GetDisplayHtml(PFField, Object, String) |
Gets the display HTML representing a value of a PFField.
(Inherited from PFItemHtmlHelper.) |
| GetDisplayHtml(PFField, PFFieldControlMode, Object, String) |
Gets the display html representing a value of a PFField.
(Inherited from PFItemHtmlHelper.) |
| GetDisplayText(PFField) |
Gets the display text representing a value of a PFField.
(Inherited from PFItemHtmlHelper.) |
| GetDisplayText(PFField, Object) |
Gets the display text representing a value of a PFField.
(Inherited from PFItemHtmlHelper.) |
| GetDisplayText(PFField, PFFieldControlMode, Object) |
Gets the display text representing a value of a PFField.
(Inherited from PFItemHtmlHelper.) |
| GetExcelValueText | Returns a text value for given field and current item, to be sent to ClosedXML API.
When using date or number values, use invariant culture for serialization.
When overriding, please check source.CustomFieldRenderer for any other custom renderer. (Inherited from PFItemHtmlHelper.) |
| GetExpandedSectionIds |
Gets the list of expanded section ids in the format "1;2;3'.
(Inherited from PFItemHtmlHelper.) |
| GetFieldControlMode |
Gets the control mode of a field.
(Inherited from PFItemHtmlHelper.)By default, depends on page mode, if the field is read-only, the current state settings, the section mode, and the content-type synchronization mode. |
| GetFormPart |
Gets the form part with the specified guid.
(Inherited from PFItemHtmlHelper.) |
| GetFormPartHtml |
Gets the html of a given form part.
(Inherited from PFItemHtmlHelper.) |
| GetFormPartObject |
Gets a form part definition by its guid.
(Inherited from PFItemHtmlHelper.) |
| GetGridViewAsyncResult |
Gets the asynchronous result of a gridview request/action.
(Inherited from PFItemHtmlHelper.) |
| GetGridviewEditableRow |
Generates html of a gridview editable row representing the current PFItem.
(Inherited from PFItemHtmlHelper.)Result will contain Html or Error, set in the operation result tag. |
| GetGridViewObject |
Gets a gridview definition by its name.
(Inherited from PFItemHtmlHelper.) |
| GetGridviewPlaceHolder |
Gets the placeholder of the gridview with the specified name.
(Inherited from PFItemHtmlHelper.) |
| GetGridviewRow |
Generates html of a gridview row representing the current PFItem.
(Inherited from PFItemHtmlHelper.)Result will contain Html or Error, set in the operation result tag. |
| GetInformationFrame |
Gets the frame (html) containing general informations about the current item.
(Inherited from PFItemHtmlHelper.)No longer shown by default. |
| GetLabelHtml(PFField) |
Gets the label html of a PFField.
(Inherited from PFItemHtmlHelper.) |
| GetLabelHtml(PFField, PFFieldControlMode) |
Gets the label html of a PFField, in a given control mode.
(Inherited from PFItemHtmlHelper.) |
| GetLabelText |
Gets the label text of a PFField.
(Inherited from PFItemHtmlHelper.) |
| GetLabelTooltip |
Gets the label tooltip text of a PFField.
(Inherited from PFItemHtmlHelper.) |
| GetNotificationsFrame |
Gets the frame (html) containing notifications.
(Inherited from PFItemHtmlHelper.) |
| GetSectionsMaxWidth |
Gets the max width of sections (limited by the container) in pixels.
(Inherited from PFItemHtmlHelper.)0 will remove the width limitation. -1 (default value) will use the default max-width. |
| GetSectionsMaxWidthStyle |
Gets the sections maximum width CSS style.
(Inherited from PFItemHtmlHelper.) |
| GetSectionTitle |
Gets the title of a section with a specified (modeling) id.
(Inherited from PFItemHtmlHelper.) |
| GetUnobtrusiveValidationAttributes(String) | (Inherited from HtmlHelper.) |
| GetUnobtrusiveValidationAttributes(String, ModelMetadata) | (Inherited from HtmlHelper.) |
| GetWorkflowFrame |
Gets the frame (html) containing workflow informations of the current item.
(Inherited from PFItemHtmlHelper.)No more shown by default. |
| HttpMethodOverride(HttpVerbs) | (Inherited from HtmlHelper.) |
| HttpMethodOverride(String) | (Inherited from HtmlHelper.) |
| IsControlVisible |
Determines whether a field of a given name is visible or not.
(Inherited from PFItemHtmlHelper.) |
| IsFormPartVisible(Guid) |
Determines whether a form part with a given guid is visible or not.
(Inherited from PFItemHtmlHelper.) |
| IsFormPartVisible(WebFormPart) |
Determines whether a form part is visible or not.
(Inherited from PFItemHtmlHelper.)By default, is based on the model settings. |
| IsSectionExpanded |
Determines whether the specified section is expanded by default.
(Inherited from PFItemHtmlHelper.) |
| IsSectionVisible |
Determines whether a section with a specified (modeling) id is shown or not.
(Inherited from PFItemHtmlHelper.)By default, is based on the current state modeling settings. But returns true anyway if the unlimited modifications mode is active. |
| LabelForTProperty |
Gets the label html of a PFField, given a certain expression.
This method is called from generated ASPX forms. From CSharp, you can call directly the GetLabelHtml method. |
| NavigationFocus |
Generates an html input containing navigation focus information.
(Inherited from PFItemHtmlHelper.)Contains the mode (Default or Admin) and the section id separated by ";". |
| Notifications |
Gets the notifications html.
(Inherited from PFItemHtmlHelper.) |
| Notifications(Boolean) |
Gets the notifications text or html.
(Inherited from PFItemHtmlHelper.) |
| PageTitle |
Gets the text displayed in the title tag of the page.
(Inherited from PFItemHtmlHelper.) |
| PermissionContextsChoice |
Generates the html of the context selection section.
(Inherited from PFItemHtmlHelper.) |
| Raw(String) | (Inherited from HtmlHelper.) |
| Raw(Object) | (Inherited from HtmlHelper.) |
| RefreshPageOnItemContextSelection |
Indicates if the page must be refreshed on context selection.
(Inherited from PFItemHtmlHelper.)By default, returns true if there is any choice or user field with a scope under the application context. |
| SetValidationMessageElement | (Inherited from HtmlHelper.) |
| SetValidationSummaryMessageElement | (Inherited from HtmlHelper.) |
| ShowStateInCaption |
Gets a value indicating whether the state is shown in the caption of the actions bar.
(Inherited from PFItemHtmlHelper.) |
| TechnicalInformations |
Generates an (hidden) html containing technical informations for JavaScript.
(Inherited from PFItemHtmlHelper.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| UseCollapsableSections |
Determines whether the sections can be collapsed or not.
By default, returns TRUE if tabs are not enabled and if collapsable sections are active on the model.
(Inherited from PFItemHtmlHelper.) |
| UseTabs |
Determines whether the sections are displayed as Tabs or not.
(Inherited from PFItemHtmlHelper.)By default, returns false if the print mode is active, then depends on the user setting, and then on the model setting. |
| VersionNumber |
Generates an html input containing the loaded version number of the current item.
(Inherited from PFItemHtmlHelper.) |
Extension Methods| Name | Description | |
|---|---|---|
 | AsT |
Casts an object to another type. Returns default(T) if the object is null.
(Defined by Utils_Other.) |
| EqualsAll |
Checks that this object is equal to every object in parameters.
(Defined by Utils_Other.) |
| EqualsAny |
Checks that this object is equal to at least one of the parameters.
(Defined by Utils_Other.) |
| GetString |
Converts an object to String using ToString() method, else returns String.Empty.
(Defined by Utils_Other.) |
| IsGenericList | Overloaded.
Checks if this object is a System.Collections.Generic.List.
(Defined by Utils_Linq.) |
| IsGenericList(Type) | Overloaded.
Checks if this object is a System.Collections.Generic.List using type as T.
(Defined by Utils_Linq.) |
| Json(Boolean) | Overloaded.
Returns the JSON representation of the given value.
(Defined by HtmlHelperExtensions.) |
| Json(Object, JavaScriptEncoding, Boolean) | Overloaded.
Returns the JSON representation of the given value.
(Defined by HtmlHelperExtensions.) |
| Serialize | Overloaded.
Serializes an object into an XML document.
(Defined by Utils_Xml.) |
| Serialize(String) | Overloaded.
Serializes an object into an XML document.
(Defined by Utils_Xml.) |
| SerializeJson | Overloaded.
Serializes an object using a DataContractJsonSerializer.
(Defined by Utils_String.) |
| SerializeJson(ListType) | Overloaded.
Serializes an object using a DataContractJsonSerializer.
(Defined by Utils_String.) |
| SerializeJson(DataContractJsonSerializerSettings) | Overloaded.
Serializes an object using a DataContractJsonSerializer.
(Defined by Utils_String.) |
See Also