PFGridViewSettingsData Class

Represents the inner settings of a gridview.

Note: inner settings are transmitted to client-side who will send them to SignalR. Then, the server will create a new instance of settings from these inner settings. To setup a gridview, you can use the not-inner settings classes.

Inheritance Hierarchy

SystemObject
  Packflow.InterfacePFGridViewSettingsData
    Packflow.InterfacePFGridViewSettingsData_Items
    Packflow.InterfacePFGridViewSettingsData_MultiContent
    Packflow.InterfacePFGridViewSettingsData_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 abstract class PFGridViewSettingsData

The PFGridViewSettingsData type exposes the following members.

Constructors

	Name	Description
	PFGridViewSettingsData	Initializes a new instance of the PFGridViewSettingsData class.

Top

Properties

	Name	Description
	AutoOpenGroups	Gets or sets a value indicating whether the first level of groups must be directly opened/loaded.
	Culture	Gets the culture code (two letters format).
	CustomFilters	Obsolete. Old setting. Do not use.
	CustomServerFilters	Gets or sets the server-side custom filters.
	CustomSortFieldName	Gets or sets the custom sort field name.
	CustomSortOrder	Gets or sets the custom sort order.
	DataType	Gets or sets the kind of data targeted by the gridview.
	DisableAllLinks	Gets or sets a value indicating whether the links generated in the gridview should be inactive. Note: also depend on PFView setting.
	EnableCheckboxes	Gets or sets a value indicating whether checkboxes are shown at the beginning of each row.
	Enabled	Gets or sets a value indicating whether the gridview is enabled. If set to False, the gridview will not load until the setting is set back to True.
	GroupsInfos	Gets or sets the groups infos (technical, used client side).
	IncludeSourceInUrls	Gets or sets a value indicating whether the URLs should contain a source (generally the current page).
	MaxColumns	Gets or sets the maximum number columns that can be shown.
	Name	Gets or sets the gridview name.
	NavigationSessionId	Gets the id of the current user session, used to find the corresponding [!:Packflow.Core.PFNavigationSession].
	PageNumber	Gets or sets the number of the loaded page.
	QuickSearchFields	Gets or sets the list of field names (=key) and display names (=value) used for quick searches. If TargetingMode is set to Default, this list will only apply on the current view. If TargetingMode is set to Custom, this list will apply even if the view changes client-side.
	QuickSearchTargetingMode	Gets or sets a value indicating how the quicksearch feature is selecting the fields to be filtered.
	ResultsScope	Gets or sets the results scope: deleted, not deleted or both.
	SerializedCustomServerFilters	Gets or sets the serialized server-side custom filters.
	ShowAvailableValuesInFilters	Gets or sets a value indicating whether available values are proposed when filtering a text/choice/user field (header popup).
	ShowOpenFormIcon	Gets or sets a value indicating whether the icon opening the item form is shown (on each row).
	Url_Source	Gets or sets the source URL.
	UserFilters	Gets or sets the user filters (usually filled client-side with the various filtering features).

Top

Methods

	Name	Description
	GetData(String)	Gets a setting metadata.
	GetDataT(String)	Gets a setting metadata.
	GetGridViewData	Gets GridView settings properties (does not include placeHolder settings!).
	SetCustomFilters	Obsolete. Old method. Do not use.
	SetData	Sets the value of a setting
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Fields

	Name	Description
	Setting_AutoOpenGroups	Setting name, used to store value in the local dictionary and represent the value client-side.
	Setting_Culture	Setting name, used to store value in the local dictionary and represent the value client-side.
	Setting_CustomFilters	Setting name, used to store value in the local dictionary and represent the value client-side.
	Setting_CustomSortFieldName	Setting name, used to store value in the local dictionary and represent the value client-side.
	Setting_CustomSortOrder	Setting name, used to store value in the local dictionary and represent the value client-side.
	Setting_DataType	Setting name, used to store value in the local dictionary and represent the value client-side.
	Setting_DisableAllLinks	Setting name, used to store value in the local dictionary and represent the value client-side.
	Setting_EnableCheckboxes	Setting name, used to store value in the local dictionary and represent the value client-side.
	Setting_Enabled	Setting name, used to store value in the local dictionary and represent the value client-side.
	Setting_FixedHeader	Setting name, used to store value in the local dictionary and represent the value client-side.
	Setting_GroupsInfos	Setting name, used to store value in the local dictionary and represent the value client-side.
	Setting_IncludeSourceInUrls	Setting name, used to store value in the local dictionary and represent the value client-side.
	Setting_MaxColumns	Setting name, used to store value in the local dictionary and represent the value client-side.
	Setting_Name	Setting name, used to store value in the local dictionary and represent the value client-side.
	Setting_NavigationSessionId	Setting name, used to store value in the local dictionary and represent the value client-side.
	Setting_PageNumber	Setting name, used to store value in the local dictionary and represent the value client-side.
	Setting_QuickSearchFields	Setting name, used to store value in the local dictionary and represent the value client-side.
	Setting_QuickSearchTargetingMode	Setting name, used to store value in the local dictionary and represent the value client-side.
	Setting_ResultsScope	Setting name, used to store value in the local dictionary and represent the value client-side.
	Setting_SerializedCustomServerFilters	Setting name, used to store value in the local dictionary and represent the value client-side.
	Setting_ShowAvailableValuesInFilters	Setting name, used to store value in the local dictionary and represent the value client-side.
	Setting_ShowOpenFormIcon	Setting name, used to store value in the local dictionary and represent the value client-side.
	Setting_SourceUrl	Setting name, used to store value in the local dictionary and represent the value client-side.
	Setting_UserFilters	Setting name, used to store value in the local dictionary and represent the value client-side.

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