Click or drag to resize

PFItemHtmlHelper Methods

The PFItemHtmlHelper type exposes the following members.

Methods
  NameDescription
Public methodAntiForgeryToken (Inherited from HtmlHelper.)
Public methodAntiForgeryToken(String) Obsolete. (Inherited from HtmlHelper.)
Public methodAntiForgeryToken(String, String, String) Obsolete. (Inherited from HtmlHelper.)
Public methodAttributeEncode(String) (Inherited from HtmlHelper.)
Public methodAttributeEncode(Object) (Inherited from HtmlHelper.)
Public methodBeginPackflowForm
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.
Public methodCustomizeActions
Override this method to customize, add or remove actions from the actions bar.
Public methodCustomizeGridViewSettings
Customizes the settings of a given gridview.
Public methodEnableClientValidation (Inherited from HtmlHelper.)
Public methodEnableClientValidation(Boolean) (Inherited from HtmlHelper.)
Public methodEnableGridViewCheckboxes
Determines if the checkboxes are enabled in the gridview with the specified name.

By default, returns false.

Public methodEnableUnobtrusiveJavaScript (Inherited from HtmlHelper.)
Public methodEnableUnobtrusiveJavaScript(Boolean) (Inherited from HtmlHelper.)
Public methodEncode(String) (Inherited from HtmlHelper.)
Public methodEncode(Object) (Inherited from HtmlHelper.)
Public methodFormatValue (Inherited from HtmlHelper.)
Public methodGetAllFieldControlMode
Gets the control mode of all field.
Public methodGetButton
Gets the button with the specified guid.
Protected methodGetButtonConfirmationMessage
Gets the confirmation message of a given button.

By default, depends on the model. No confirmation dialog is shown if the text is empty.

Protected methodGetButtonContent
Gets the caption of a given button.
Protected methodGetButtonHtml
Gets the html of a given button.
Protected methodGetButtonMode
Gets the control mode of a button.

By default, depends on page mode, button settings and the current state settings.

Protected methodGetButtonObject
Gets a button definition by its guid.
Public methodGetCaption
Gets the html displayed in the caption of the actions bar.
Public methodGetControlHtml(PFField, Object)
Gets the html of a PFField control, loaded with the specified value.
Protected methodGetControlHtml(PFField, PFFieldControlMode, Object)
Gets the html of a PFField control in a specific mode, loaded with the specified value.
Public methodGetCustomCaptionIconLetters
Gets the custom icon letters for the actions bar caption.
Protected methodGetCustomFiltersForChoicePossibleItems
Gets the custom filters for a choice field, mixed with the filters of the view.

The result is used to refine the list of selectable values of a PFFieldChoice.

By default, returns null.

Public methodGetDefaultSection
Gets the id of the section focused by default (by scrolling or the default selected tab).

The default value is retrieved from the current item's state.

Public methodGetDisplayHtml(PFField, String)
Gets the display HTML representing a value of a PFField.
Public methodGetDisplayHtml(PFField, Object, String)
Gets the display HTML representing a value of a PFField.
Protected methodGetDisplayHtml(PFField, PFFieldControlMode, Object, String)
Gets the display html representing a value of a PFField.
Public methodGetDisplayText(PFField)
Gets the display text representing a value of a PFField.
Public methodGetDisplayText(PFField, Object)
Gets the display text representing a value of a PFField.
Protected methodGetDisplayText(PFField, PFFieldControlMode, Object)
Gets the display text representing a value of a PFField.
Public methodGetExcelValueText
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.
Public methodGetExpandedSectionIds
Gets the list of expanded section ids in the format "1;2;3'.
Public methodGetFieldControlMode
Gets the control mode of a field.

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.

Public methodGetFormPart
Gets the form part with the specified guid.
Protected methodGetFormPartHtml
Gets the html of a given form part.
Protected methodGetFormPartObject
Gets a form part definition by its guid.
Public methodGetGridViewAsyncResult
Gets the asynchronous result of a gridview request/action.
Public methodGetGridviewEditableRow
Generates html of a gridview editable row representing the current PFItem.

Result will contain Html or Error, set in the operation result tag.

Protected methodGetGridViewObject
Gets a gridview definition by its name.
Public methodGetGridviewPlaceHolder
Gets the placeholder of the gridview with the specified name.
Public methodGetGridviewRow
Generates html of a gridview row representing the current PFItem.

Result will contain Html or Error, set in the operation result tag.

Public methodGetInformationFrame
Gets the frame (html) containing general informations about the current item.

No longer shown by default.

Public methodGetLabelHtml(PFField)
Gets the label html of a PFField.
Protected methodGetLabelHtml(PFField, PFFieldControlMode)
Gets the label html of a PFField, in a given control mode.
Protected methodGetLabelText
Gets the label text of a PFField.
Protected methodGetLabelTooltip
Gets the label tooltip text of a PFField.
Public methodGetNotificationsFrame
Gets the frame (html) containing notifications.
Public methodGetSectionsMaxWidth
Gets the max width of sections (limited by the container) in pixels.

0 will remove the width limitation.

-1 (default value) will use the default max-width.

Public methodGetSectionsMaxWidthStyle
Gets the sections maximum width CSS style.
Public methodGetSectionTitle
Gets the title of a section with a specified (modeling) id.
Public methodGetUnobtrusiveValidationAttributes(String) (Inherited from HtmlHelper.)
Public methodGetUnobtrusiveValidationAttributes(String, ModelMetadata) (Inherited from HtmlHelper.)
Public methodGetWorkflowFrame
Gets the frame (html) containing workflow informations of the current item.

No more shown by default.

Public methodHttpMethodOverride(HttpVerbs) (Inherited from HtmlHelper.)
Public methodHttpMethodOverride(String) (Inherited from HtmlHelper.)
Public methodIsControlVisible
Determines whether a field of a given name is visible or not.
Public methodIsFormPartVisible(Guid)
Determines whether a form part with a given guid is visible or not.
Public methodIsFormPartVisible(WebFormPart)
Determines whether a form part is visible or not.

By default, is based on the model settings.

Public methodIsSectionExpanded
Determines whether the specified section is expanded by default.
Public methodIsSectionVisible
Determines whether a section with a specified (modeling) id is shown or not.

By default, is based on the current state modeling settings. But returns true anyway if the unlimited modifications mode is active.

Public methodNavigationFocus
Generates an html input containing navigation focus information.

Contains the mode (Default or Admin) and the section id separated by ";".

Public methodNotifications
Gets the notifications html.
Public methodNotifications(Boolean)
Gets the notifications text or html.
Public methodPageTitle
Gets the text displayed in the title tag of the page.
Public methodPermissionContextsChoice
Generates the html of the context selection section.
Public methodRaw(String) (Inherited from HtmlHelper.)
Public methodRaw(Object) (Inherited from HtmlHelper.)
Protected methodRefreshPageOnItemContextSelection
Indicates if the page must be refreshed on context selection.

By default, returns true if there is any choice or user field with a scope under the application context.

Public methodSetValidationMessageElement (Inherited from HtmlHelper.)
Public methodSetValidationSummaryMessageElement (Inherited from HtmlHelper.)
Public methodShowStateInCaption
Gets a value indicating whether the state is shown in the caption of the actions bar.
Public methodTechnicalInformations
Generates an (hidden) html containing technical informations for JavaScript.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUseCollapsableSections
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.
Public methodUseTabs
Determines whether the sections are displayed as Tabs or not.

By default, returns false if the print mode is active, then depends on the user setting, and then on the model setting.

Public methodVersionNumber
Generates an html input containing the loaded version number of the current item.
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 MethodJson(Boolean)Overloaded.
Returns the JSON representation of the given value.
(Defined by HtmlHelperExtensions.)
Public Extension MethodJson(Object, JavaScriptEncoding, Boolean)Overloaded.
Returns the JSON representation of the given value.
(Defined by HtmlHelperExtensions.)
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