PFGridViewHtmlHelperTPFBaseObject Class |
Provides methods for the generation of gridviews.
Inheritance HierarchySystemObject
Packflow.InterfacePFGridViewHtmlHelperTPFBaseObject
Packflow.InterfacePFGridViewHtmlHelper_Items
Packflow.InterfacePFGridViewHtmlHelper_MultiContent
Packflow.InterfacePFGridViewHtmlHelper_Objects
Packflow.InterfacePFGridViewHtmlHelperTPFBaseObject
Packflow.InterfacePFGridViewHtmlHelper_Items
Packflow.InterfacePFGridViewHtmlHelper_MultiContent
Packflow.InterfacePFGridViewHtmlHelper_Objects
Namespace: Packflow.Interface
Assembly: MicaSystems.Packflow.Interface (in MicaSystems.Packflow.Interface.dll) Version: 1.0.0.0 (2.0.0.223)
SyntaxC#
public abstract class PFGridViewHtmlHelper<TPFBaseObject> where TPFBaseObject : PFBaseObject
Type Parameters
- TPFBaseObject
The PFGridViewHtmlHelperTPFBaseObject type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | PFGridViewHtmlHelperTPFBaseObject(PFSite, PFGridViewSettingsData) |
Initializes a new instance of the PFGridViewHtmlHelper class.
|
| PFGridViewHtmlHelperTPFBaseObject(PFSite, PFGridViewSettingsData, Int32, String, Int32, String) |
Initializes a new instance of the PFGridViewHtmlHelper class.
|
Properties| Name | Description | |
|---|---|---|
 | BaseQuery |
Gets the base PFQuery.
|
| ClientFilters |
Gets the client filters (initialized from ClientFiltersText).
|
| ClientFiltersText |
Gets the text containing client filters.
Includes users (UsersFiltersText) filters and custom client filters (CustomFiltersText).
|
| CustomFiltersText | Obsolete.
Old setting. Do not use.
|
| CustomQuickSearchtext |
Gets or sets a text used to force a quick search, replacing the existing one if any.
|
| CustomServerFilters |
Gets the server-side custom filters.
|
| FullPaging | Gets a value indicating whether the generation should show all the available pages. This has a performance cost growing with data size. |
 | GridViewAdditionnalFilters |
Gets filters obtained locally (from this class), to be used in the Query.
|
| Group |
Gets the top level definition of groups.
|
| GroupContent |
Gets a value indicating whether a group content is being loaded.
|
| GroupContentLevel |
Gets the group depth (starting with 0 at the root).
|
| GroupNextlevelIsObjects |
Gets a value indicating whether objects or groups of objects are being loaded.
|
| OrderGroupEntriesByTitle |
Gets a value indicating whether the requested groups
should be ordered on the front-end side by their display value, even if custom.
|
| PageNumber |
Gets the number of the page to load (starting with 1).
In a group load context, returns the page number inside the group. |
| ParentGroupHtmlId |
Gets the parent group id of the data being loaded, if appropriate.
|
| Query |
Gets the PFQuery to execute.
This is the base query plus custom filters, paging, scope, groups settings and required columns. |
| QuickSearchColumns |
Gets the column names filtered during a quicksearch.
|
| RequiredColumns |
Gets the name of columns that must be selected in the query.
|
| Settings |
Gets the gridview settings.
|
| Site |
Gets the contextual Packflow Site.
|
| TableColCount |
Gets the count of columns in the output table, including columns not containing data
(like the selection checkbox column or inline actions).
|
| Translations |
Gets the contextual translations provided by Packflow.
|
| TranslationsInitialized |
Gets a value indicating whether the Translations object is initialized.
|
| UsersFiltersText |
Gets the text containing user filters (usually filled client-side with the various filtering features).
|
| ViewColumns |
Gets the column names of the current view.
|
Methods| Name | Description | |
|---|---|---|
 | CustomizeQuery |
Customizes the query after its initialization.
|
| Generate |
Generates the gridview's HTML, containing data or group rows with aggregations and paging information.
|
| GetColumnOrder |
Gets the type of ordering of a column, based on the CustomSortFieldName setting.
Returns null if the column is not involved.
|
| GetGlobalAggregationsRow |
Generates the global aggregation row's HTML.
|
| GetGroupHtml |
Generates a group's HTML.
|
| GetHeaderRow |
Generates the header's HTML.
|
| GetHiddenData |
Gets an HTML containing hidden information, usually intended for the JavaScript code.
|
| GetObjectRow |
Generates the HTML of the object's row and appends it to the builder.
|
| GetObjects |
Executes the query on the parent object to retrieve the objects to show in the gridview.
|
| GetObjectsByGroup |
Executes the query on the parent object to retrieve the groups to show in the gridview.
|
| GetPagingInformations |
Generates the paging part of the gridview.
|
| HandleViewChange |
Handles the specific case of a view load targeting
a different view than the previous load of the same gridview.
|
| IsColumnFilteredByUser |
Gets a value indicating whether the column is involved in a user (client-side) filter.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Fields| Name | Description | |
|---|---|---|
  | Aggregation_PF_RowCount |
Aggregation name used in PFQuery to obtain the row count inside groups.
|
| FilterSeparator |
Client filters are concatenated using this separator.
|
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.) |
| 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