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

Copy

public class PFGridViewHtmlHelper_Objects : PFGridViewHtmlHelper<PFBaseObject>

The PFGridViewHtmlHelper_Objects type exposes the following members.

Constructors

	Name	Description
	PFGridViewHtmlHelper_Objects(PFSite, PFGridViewSettingsData_Objects)	Initializes a new instance of the PFGridViewHtmlHelper_Objects class.
	PFGridViewHtmlHelper_Objects(PFSite, PFGridViewSettingsData_Objects, Int32, String, Int32, String)	Initializes a new instance of the PFGridViewHtmlHelper_Objects class.

Top

Properties

	Name	Description
	BaseQuery	Gets the base PFQuery. (Overrides PFGridViewHtmlHelperTPFBaseObjectBaseQuery.)
	ClientFilters	Gets the client filters (initialized from ClientFiltersText). (Inherited from PFGridViewHtmlHelperTPFBaseObject.)
	ClientFiltersText	Gets the text containing client filters. Includes users (UsersFiltersText) filters and custom client filters (CustomFiltersText). (Inherited from PFGridViewHtmlHelperTPFBaseObject.)
	CustomFiltersText	Obsolete. Old setting. Do not use. (Inherited from PFGridViewHtmlHelperTPFBaseObject.)
	CustomQuickSearchtext	Gets or sets a text used to force a quick search, replacing the existing one if any. (Inherited from PFGridViewHtmlHelperTPFBaseObject.)
	CustomServerFilters	Gets the server-side custom filters. (Inherited from PFGridViewHtmlHelperTPFBaseObject.)
	FullPaging	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.)
	GridViewAdditionnalFilters	Gets filters obtained locally (from this class), to be used in the Query. (Inherited from PFGridViewHtmlHelperTPFBaseObject.)
	Group	Gets the top level definition of groups. (Inherited from PFGridViewHtmlHelperTPFBaseObject.)
	GroupContent	Gets a value indicating whether a group content is being loaded. (Inherited from PFGridViewHtmlHelperTPFBaseObject.)
	GroupContentLevel	Gets the group depth (starting with 0 at the root). (Inherited from PFGridViewHtmlHelperTPFBaseObject.)
	GroupNextlevelIsObjects	Gets a value indicating whether objects or groups of objects are being loaded. (Inherited from PFGridViewHtmlHelperTPFBaseObject.)
	OrderGroupEntriesByTitle	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.)
	PageNumber	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.)
	ParentGroupHtmlId	Gets the parent group id of the data being loaded, if appropriate. (Inherited from PFGridViewHtmlHelperTPFBaseObject.)
	ParentObject	Gets the parent object of the shown data.
	ParentRelation	Gets the objects relation, linking the data with the ParentObject.
	Query	Gets the PFQuery to execute. This is the base query plus custom filters, paging, scope, groups settings and required columns. (Inherited from PFGridViewHtmlHelperTPFBaseObject.)
	QuickSearchColumns	Gets the column names filtered during a quicksearch. (Overrides PFGridViewHtmlHelperTPFBaseObjectQuickSearchColumns.)
	RequiredColumns	Gets the name of columns that must be selected in the query. (Overrides PFGridViewHtmlHelperTPFBaseObjectRequiredColumns.)
	Settings	Gets the gridview settings.
	Site	Gets the contextual Packflow Site. (Inherited from PFGridViewHtmlHelperTPFBaseObject.)
	TableColCount	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.)
	Translations	Gets the contextual translations provided by Packflow. (Inherited from PFGridViewHtmlHelperTPFBaseObject.)
	TranslationsInitialized	Gets a value indicating whether the Translations object is initialized. (Inherited from PFGridViewHtmlHelperTPFBaseObject.)
	UsersFiltersText	Gets the text containing user filters (usually filled client-side with the various filtering features). (Inherited from PFGridViewHtmlHelperTPFBaseObject.)
	ViewColumns	Gets the column names of the current view (Settings.ObjectsViewName). (Overrides PFGridViewHtmlHelperTPFBaseObjectViewColumns.)
	ViewHelper	Gets the html helper handling the objects' type of the relation's children.

Top

Methods

	Name	Description
	CustomizeQuery	Customizes the query after its initialization. (Inherited from PFGridViewHtmlHelperTPFBaseObject.)
	Generate	Generates the gridview's HTML, containing data or group rows with aggregations and paging information. (Inherited from PFGridViewHtmlHelperTPFBaseObject.)
	GetColumnOrder	Gets the type of ordering of a column, based on the CustomSortFieldName setting. Returns null if the column is not involved. (Inherited from PFGridViewHtmlHelperTPFBaseObject.)
	GetContent	Generates the content of a gridview.
	GetGlobalAggregationsRow	Generates the global aggregation row's HTML. (Overrides PFGridViewHtmlHelperTPFBaseObjectGetGlobalAggregationsRow.)
	GetGroupContent	Generates the content of a gridview's group.
	GetGroupHtml	Generates a group's HTML. (Overrides PFGridViewHtmlHelperTPFBaseObjectGetGroupHtml(PFGroupedObjects, String, Int64, Int32, Int64).)
	GetHeaderRow	Generates the header's HTML. (Overrides PFGridViewHtmlHelperTPFBaseObjectGetHeaderRow.)
	GetHiddenData	Gets an HTML containing hidden information, usually intended for the JavaScript code. (Inherited from PFGridViewHtmlHelperTPFBaseObject.)
	GetObjectRow	Generates the HTML of the object's row and appends it to the builder. (Overrides PFGridViewHtmlHelperTPFBaseObjectGetObjectRow(TPFBaseObject, Boolean, HtmlBuilder).)
	GetObjects	Executes the query on the parent object to retrieve the objects to show in the gridview. (Overrides PFGridViewHtmlHelperTPFBaseObjectGetObjects.)
	GetObjectsByGroup	Executes the query on the parent object to retrieve the groups to show in the gridview. (Overrides PFGridViewHtmlHelperTPFBaseObjectGetObjectsByGroup.)
	GetPagingInformations	Generates the paging part of the gridview. (Inherited from PFGridViewHtmlHelperTPFBaseObject.)
	HandleViewChange	Handles the specific case of a view load targeting a different view than the previous load of the same gridview. (Overrides PFGridViewHtmlHelperTPFBaseObjectHandleViewChange.)
	IsColumnFilteredByUser	Gets a value indicating whether the column is involved in a user (client-side) filter. (Inherited from PFGridViewHtmlHelperTPFBaseObject.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

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.)

Top

Reference

Packflow.Interface Namespace

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