Click or drag to resize

PFGridViewHtmlHelper_Objects Class

Provides methods for the generation of gridviews targeting Packflow objects like events, log entries, etc.
Inheritance Hierarchy
SystemObject
  Packflow.InterfacePFGridViewHtmlHelperPFBaseObject
    Packflow.InterfacePFGridViewHtmlHelper_Objects

Namespace:  Packflow.Interface
Assembly:  MicaSystems.Packflow.Interface (in MicaSystems.Packflow.Interface.dll) Version: 1.0.0.0 (2.0.0.223)
Syntax
C#
public class PFGridViewHtmlHelper_Objects : PFGridViewHtmlHelper<PFBaseObject>

The PFGridViewHtmlHelper_Objects type exposes the following members.

Constructors
  NameDescription
Public methodPFGridViewHtmlHelper_Objects(PFSite, PFGridViewSettingsData_Objects)
Initializes a new instance of the PFGridViewHtmlHelper_Objects class.
Public methodPFGridViewHtmlHelper_Objects(PFSite, PFGridViewSettingsData_Objects, Int32, String, Int32, String)
Initializes a new instance of the PFGridViewHtmlHelper_Objects class.
Top
Properties
  NameDescription
Public propertyBaseQuery
Gets the base PFQuery.
(Overrides PFGridViewHtmlHelperTPFBaseObjectBaseQuery.)
Public propertyClientFilters
Gets the client filters (initialized from ClientFiltersText).
(Inherited from PFGridViewHtmlHelperTPFBaseObject.)
Public propertyClientFiltersText
Gets the text containing client filters. Includes users (UsersFiltersText) filters and custom client filters (CustomFiltersText).
(Inherited from PFGridViewHtmlHelperTPFBaseObject.)
Public propertyCustomFiltersText Obsolete.
Old setting. Do not use.
(Inherited from PFGridViewHtmlHelperTPFBaseObject.)
Public propertyCustomQuickSearchtext
Gets or sets a text used to force a quick search, replacing the existing one if any.
(Inherited from PFGridViewHtmlHelperTPFBaseObject.)
Public propertyCustomServerFilters
Gets the server-side custom filters.
(Inherited from PFGridViewHtmlHelperTPFBaseObject.)
Public propertyFullPaging

Gets a value indicating whether the generation should show all the available pages.

This has a performance cost growing with data size.

(Inherited from PFGridViewHtmlHelperTPFBaseObject.)
Protected propertyGridViewAdditionnalFilters
Gets filters obtained locally (from this class), to be used in the Query.
(Inherited from PFGridViewHtmlHelperTPFBaseObject.)
Public propertyGroup
Gets the top level definition of groups.
(Inherited from PFGridViewHtmlHelperTPFBaseObject.)
Public propertyGroupContent
Gets a value indicating whether a group content is being loaded.
(Inherited from PFGridViewHtmlHelperTPFBaseObject.)
Public propertyGroupContentLevel
Gets the group depth (starting with 0 at the root).
(Inherited from PFGridViewHtmlHelperTPFBaseObject.)
Public propertyGroupNextlevelIsObjects
Gets a value indicating whether objects or groups of objects are being loaded.
(Inherited from PFGridViewHtmlHelperTPFBaseObject.)
Protected propertyOrderGroupEntriesByTitle
Gets a value indicating whether the requested groups should be ordered on the front-end side by their display value, even if custom.
(Inherited from PFGridViewHtmlHelperTPFBaseObject.)
Public propertyPageNumber
Gets the number of the page to load (starting with 1).

In a group load context, returns the page number inside the group.

(Inherited from PFGridViewHtmlHelperTPFBaseObject.)
Public propertyParentGroupHtmlId
Gets the parent group id of the data being loaded, if appropriate.
(Inherited from PFGridViewHtmlHelperTPFBaseObject.)
Public propertyParentObject
Gets the parent object of the shown data.
Public propertyParentRelation
Gets the objects relation, linking the data with the ParentObject.
Public propertyQuery
Gets the PFQuery to execute.

This is the base query plus custom filters, paging, scope, groups settings and required columns.

(Inherited from PFGridViewHtmlHelperTPFBaseObject.)
Public propertyQuickSearchColumns
Gets the column names filtered during a quicksearch.
(Overrides PFGridViewHtmlHelperTPFBaseObjectQuickSearchColumns.)
Public propertyRequiredColumns
Gets the name of columns that must be selected in the query.
(Overrides PFGridViewHtmlHelperTPFBaseObjectRequiredColumns.)
Public propertySettings
Gets the gridview settings.
Public propertySite
Gets the contextual Packflow Site.
(Inherited from PFGridViewHtmlHelperTPFBaseObject.)
Public propertyTableColCount
Gets the count of columns in the output table, including columns not containing data (like the selection checkbox column or inline actions).
(Inherited from PFGridViewHtmlHelperTPFBaseObject.)
Public propertyTranslations
Gets the contextual translations provided by Packflow.
(Inherited from PFGridViewHtmlHelperTPFBaseObject.)
Protected propertyTranslationsInitialized
Gets a value indicating whether the Translations object is initialized.
(Inherited from PFGridViewHtmlHelperTPFBaseObject.)
Public propertyUsersFiltersText
Gets the text containing user filters (usually filled client-side with the various filtering features).
(Inherited from PFGridViewHtmlHelperTPFBaseObject.)
Public propertyViewColumns
Gets the column names of the current view (Settings.ObjectsViewName).
(Overrides PFGridViewHtmlHelperTPFBaseObjectViewColumns.)
Public propertyViewHelper
Gets the html helper handling the objects' type of the relation's children.
Top
Methods
  NameDescription
Protected methodCustomizeQuery
Customizes the query after its initialization.
(Inherited from PFGridViewHtmlHelperTPFBaseObject.)
Public methodGenerate
Generates the gridview's HTML, containing data or group rows with aggregations and paging information.
(Inherited from PFGridViewHtmlHelperTPFBaseObject.)
Protected methodGetColumnOrder
Gets the type of ordering of a column, based on the CustomSortFieldName setting.

Returns null if the column is not involved.

(Inherited from PFGridViewHtmlHelperTPFBaseObject.)
Public methodStatic memberGetContent
Generates the content of a gridview.
Protected methodGetGlobalAggregationsRow
Generates the global aggregation row's HTML.
(Overrides PFGridViewHtmlHelperTPFBaseObjectGetGlobalAggregationsRow.)
Public methodStatic memberGetGroupContent
Generates the content of a gridview's group.
Protected methodGetGroupHtml
Generates a group's HTML.
(Overrides PFGridViewHtmlHelperTPFBaseObjectGetGroupHtml(PFGroupedObjects, String, Int64, Int32, Int64).)
Protected methodGetHeaderRow
Generates the header's HTML.
(Overrides PFGridViewHtmlHelperTPFBaseObjectGetHeaderRow.)
Protected methodGetHiddenData
Gets an HTML containing hidden information, usually intended for the JavaScript code.
(Inherited from PFGridViewHtmlHelperTPFBaseObject.)
Protected methodGetObjectRow
Generates the HTML of the object's row and appends it to the builder.
(Overrides PFGridViewHtmlHelperTPFBaseObjectGetObjectRow(TPFBaseObject, Boolean, HtmlBuilder).)
Protected methodGetObjects
Executes the query on the parent object to retrieve the objects to show in the gridview.
(Overrides PFGridViewHtmlHelperTPFBaseObjectGetObjects.)
Protected methodGetObjectsByGroup
Executes the query on the parent object to retrieve the groups to show in the gridview.
(Overrides PFGridViewHtmlHelperTPFBaseObjectGetObjectsByGroup.)
Protected methodGetPagingInformations
Generates the paging part of the gridview.
(Inherited from PFGridViewHtmlHelperTPFBaseObject.)
Protected methodHandleViewChange
Handles the specific case of a view load targeting a different view than the previous load of the same gridview.
(Overrides PFGridViewHtmlHelperTPFBaseObjectHandleViewChange.)
Protected methodIsColumnFilteredByUser
Gets a value indicating whether the column is involved in a user (client-side) filter.
(Inherited from PFGridViewHtmlHelperTPFBaseObject.)
Public methodToString
Returns a string that represents the current object.
(Inherited from 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

Reference

[!:Packflow.Interface.PFGridViewHtmlHelper<Packflow.Core.PFBaseObject>]