PFGridViewSettingsData_Items Class

Represents the inner settings of a gridview targeting items.

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

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 PFGridViewSettingsData_Items : PFGridViewSettingsData

The PFGridViewSettingsData_Items type exposes the following members.

Constructors

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

Top

Properties

	Name	Description
	ApplicationId	Gets or sets the target application id.
	AutoOpenGroups	Gets or sets a value indicating whether the first level of groups must be directly opened/loaded. (Inherited from PFGridViewSettingsData.)
	CanOpenFiles	Obsolete. Gets or sets a value indicating whether files can be opened.
	ContentTypeId	Gets or sets the target content-type id.
	CreationMode	Gets or sets the creation behavior.
	Culture	Gets the culture code (two letters format). (Inherited from PFGridViewSettingsData.)
	CurrentApplicationId	Gets or sets the source application id (in a relation context).
	CurrentContentTypeId	Gets or sets the source content-type id (in a relation context).
	CurrentItemId	Gets or sets the source item id (in a relation context).
	CustomFilters	Obsolete. Old setting. Do not use. (Inherited from PFGridViewSettingsData.)
	CustomServerFilters	Gets or sets the server-side custom filters. (Inherited from PFGridViewSettingsData.)
	CustomSortFieldName	Gets or sets the custom sort field name. (Inherited from PFGridViewSettingsData.)
	CustomSortOrder	Gets or sets the custom sort order. (Inherited from PFGridViewSettingsData.)
	DataType	Gets or sets the kind of data targeted by the gridview. (Inherited from PFGridViewSettingsData.)
	DisableAllLinks	Gets or sets a value indicating whether the links generated in the gridview should be inactive. Note: also depend on PFView setting. (Inherited from PFGridViewSettingsData.)
	Duplication	Gets or sets a value indicating whether duplication is enabled. Note : also depend on PFView setting.
	Edition	Gets or sets a value indicating whether the inline edition is enabled. Note : also depend on PFView setting.
	EditItemsInFrame	Gets or sets a value indicating whether item edition must be done using a frame.
	EnableCheckboxes	Gets or sets a value indicating whether checkboxes are shown at the beginning of each row. (Inherited from PFGridViewSettingsData.)
	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. (Inherited from PFGridViewSettingsData.)
	EnableItemsReferences	Gets or sets a value indicating whether items' references must be included in the rows HTML. (=PFItemReference.ToString)
	EnableSelectionMode	Gets or sets a value indicating whether the feature allowing managing relations is enabled.
	GroupsInfos	Gets or sets the groups infos (technical, used client side). (Inherited from PFGridViewSettingsData.)
	IncludeSourceInUrls	Gets or sets a value indicating whether the URLs should contain a source (generally the current page). (Inherited from PFGridViewSettingsData.)
	ItemsReferencesFieldName	Gets or sets the name of the field included as display in the items' references.
	LinkTaskToParentWorkflow	Usually each row displays a link to the form of the corresponding item. With this option enabled, the link will target the form of the parent workflow of each task. True by default.
	MaxColumns	Gets or sets the maximum number columns that can be shown. (Inherited from PFGridViewSettingsData.)
	Name	Gets or sets the gridview name. (Inherited from PFGridViewSettingsData.)
	NavigationSessionId	Gets the id of the current user session, used to find the corresponding [!:Packflow.Core.PFNavigationSession]. (Inherited from PFGridViewSettingsData.)
	OpenItemsInFrame	Gets or sets a value indicating whether items should be open in a frame.
	PageNumber	Gets or sets the number of the loaded page. (Inherited from PFGridViewSettingsData.)
	PreviousViewId	Gets or sets the view identifier whose QuickSearchFields are derived.
	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. (Inherited from PFGridViewSettingsData.)
	QuickSearchTargetingMode	Gets or sets a value indicating how the quicksearch feature is selecting the fields to be filtered. (Inherited from PFGridViewSettingsData.)
	RelationDirection	Gets or sets the relation direction.
	RelationGuid	Gets or sets the relation guid.
	RelationName	Gets or sets the relation name.
	ResultsScope	Gets or sets the results scope: deleted, not deleted or both. (Inherited from PFGridViewSettingsData.)
	RetrieveRelatedItemsIds	Gets or sets a value indicating whether the generated table should contain ids of all related items. Only if a relation is specified and if a CurrentItem is found.
	SelectionModeScope	Gets or sets the scope of available items when the selection mode is active.
	SerializedCustomServerFilters	Gets or sets the serialized server-side custom filters. (Inherited from PFGridViewSettingsData.)
	ShowAvailableValuesInFilters	Gets or sets a value indicating whether available values are proposed when filtering a text/choice/user field (header popup). (Inherited from PFGridViewSettingsData.)
	ShowOpenFormIcon	Gets or sets a value indicating whether the icon opening the item form is shown (on each row). (Inherited from PFGridViewSettingsData.)
	Suppression	Gets or sets a value indicating whether the inline suppression is enabled. Note : also depend on PFView setting.
	Unlinking	Gets or sets a value indicating whether the inline action Unlinking is enabled. This action allows removing the relation between the source item and a target item.
	Url_Source	Gets or sets the source URL. (Inherited from PFGridViewSettingsData.)
	Url_Template	Gets or sets the template URL PAGE_NAME/APPLICATION_NAME/CONTENTTYPE_NAME/ITEM_ID/?View=VIEW_ID
	UseRelation	Gets or sets a value indicating whether the specified relation should be used from the current item to filter items. Default value: True.
	UserFilters	Gets or sets the user filters (usually filled client-side with the various filtering features). (Inherited from PFGridViewSettingsData.)
	ViewId	Gets or sets the target view id.

Top

Methods

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

Top

Fields

	Name	Description
	Setting_Application	Setting name, used to store value in the local dictionary and represent the value client-side.
	Setting_CanOpenFiles	Setting name, used to store value in the local dictionary and represent the value client-side.
	Setting_ContentType	Setting name, used to store value in the local dictionary and represent the value client-side.
	Setting_CreationMode	Setting name, used to store value in the local dictionary and represent the value client-side.
	Setting_CurrentApplication	Setting name, used to store value in the local dictionary and represent the value client-side.
	Setting_CurrentContentType	Setting name, used to store value in the local dictionary and represent the value client-side.
	Setting_CurrentItem	Setting name, used to store value in the local dictionary and represent the value client-side.
	Setting_Duplication	Setting name, used to store value in the local dictionary and represent the value client-side.
	Setting_Edition	Setting name, used to store value in the local dictionary and represent the value client-side.
	Setting_EditItemsInFrame	Setting name, used to store value in the local dictionary and represent the value client-side.
	Setting_EnableItemsReferences	Setting name, used to store value in the local dictionary and represent the value client-side.
	Setting_EnableSelectionMode	Setting name, used to store value in the local dictionary and represent the value client-side.
	Setting_ItemsReferencesFieldName	Setting name, used to store value in the local dictionary and represent the value client-side.
	Setting_LinkTaskToParentWorkflow	Setting name, used to store value in the local dictionary and represent the value client-side.
	Setting_OpenItemsInFrame	Setting name, used to store value in the local dictionary and represent the value client-side.
	Setting_Relation	Setting name, used to store value in the local dictionary and represent the value client-side.
	Setting_RelationDirection	Setting name, used to store value in the local dictionary and represent the value client-side.
	Setting_RelationName	Setting name, used to store value in the local dictionary and represent the value client-side.
	Setting_RetrieveRelatedItemsIds	Setting name, used to store value in the local dictionary and represent the value client-side.
	Setting_SelectionModeScope	Setting name, used to store value in the local dictionary and represent the value client-side.
	Setting_Suppression	Setting name, used to store value in the local dictionary and represent the value client-side.
	Setting_TemplateUrl	Setting name, used to store value in the local dictionary and represent the value client-side.
	Setting_Unlinking	Setting name, used to store value in the local dictionary and represent the value client-side.
	Setting_UseRelation	Setting name, used to store value in the local dictionary and represent the value client-side.
	Setting_View	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

Packflow.InterfacePFGridViewSettingsData