Click or drag to resize

PFGridViewSettings_Items Class

Represents the settings of a gridview targeting items.
Inheritance Hierarchy

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

The PFGridViewSettings_Items type exposes the following members.

Constructors
  NameDescription
Public methodPFGridViewSettings_Items
Top
Properties
  NameDescription
Public propertyApplicationId
Gets or sets the target application id.
(Inherited from PFGridViewSettingsData_Items.)
Public propertyAutoOpenGroups
Gets or sets a value indicating whether the first level of groups must be directly opened/loaded.
(Inherited from PFGridViewSettingsData.)
Public propertyCanOpenFiles Obsolete.
Gets or sets a value indicating whether files can be opened.
(Inherited from PFGridViewSettingsData_Items.)
Public propertyContentTypeId
Gets or sets the target content-type id.
(Inherited from PFGridViewSettingsData_Items.)
Public propertyCreationButtonContent
Gets or sets the content shown in the creation button.
Public propertyCreationMode
Gets or sets the creation behavior.
(Inherited from PFGridViewSettingsData_Items.)
Public propertyCulture
Gets the culture code (two letters format).
(Inherited from PFGridViewSettingsData.)
Public propertyCurrentApplication
Gets the source application.

Changing the CurrentItem or CurrentContentType will affect this property.

Public propertyCurrentApplicationId
Gets or sets the source application id (in a relation context).
(Inherited from PFGridViewSettingsData_Items.)
Public propertyCurrentContentType
Gets or sets the source content-type.

Changing the CurrentItem will affect this property.

You can set this property without a CurrentItem if you want to specify the source item later on client-side.

Public propertyCurrentContentTypeId
Gets or sets the source content-type id (in a relation context).
(Inherited from PFGridViewSettingsData_Items.)
Public propertyCurrentItem
Gets or sets the source item (in a relation context).

You must also specify the Relation.

Public propertyCurrentItemId
Gets or sets the source item id (in a relation context).
(Inherited from PFGridViewSettingsData_Items.)
Public propertyCustomFilters Obsolete.
Old setting. Do not use.
(Inherited from PFGridViewSettingsData.)
Public propertyCustomServerFilters
Gets or sets the server-side custom filters.
(Inherited from PFGridViewSettingsData.)
Public propertyCustomSortFieldName
Gets or sets the custom sort field name.
(Inherited from PFGridViewSettingsData.)
Public propertyCustomSortOrder
Gets or sets the custom sort order.
(Inherited from PFGridViewSettingsData.)
Public propertyDataType
Gets or sets the kind of data targeted by the gridview.
(Inherited from PFGridViewSettingsData.)
Public propertyDefaultTemplate Obsolete.
Gets or sets the default template. Obsolete.
Public propertyDisableAllLinks
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.)
Public propertyDocTemplates Obsolete.
Gets or sets the document templates. Obsolete.
Public propertyDuplication
Gets or sets a value indicating whether duplication is enabled. Note : also depend on PFView setting.
(Inherited from PFGridViewSettingsData_Items.)
Public propertyEdition
Gets or sets a value indicating whether the inline edition is enabled. Note : also depend on PFView setting.
(Inherited from PFGridViewSettingsData_Items.)
Public propertyEditItemsInFrame
Gets or sets a value indicating whether item edition must be done using a frame.
(Inherited from PFGridViewSettingsData_Items.)
Public propertyEnableCheckboxes
Gets or sets a value indicating whether checkboxes are shown at the beginning of each row.
(Inherited from PFGridViewSettingsData.)
Public propertyEnabled
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.)
Public propertyEnableItemsReferences
Gets or sets a value indicating whether items' references must be included in the rows HTML. (=PFItemReference.ToString)
(Inherited from PFGridViewSettingsData_Items.)
Public propertyEnableSelectionMode
Gets or sets a value indicating whether the feature allowing managing relations is enabled.
(Inherited from PFGridViewSettingsData_Items.)
Public propertyGroupsInfos
Gets or sets the groups infos (technical, used client side).
(Inherited from PFGridViewSettingsData.)
Public propertyIncludeSourceInUrls
Gets or sets a value indicating whether the URLs should contain a source (generally the current page).
(Inherited from PFGridViewSettingsData.)
Public propertyItemsReferencesFieldName
Gets or sets the name of the field included as display in the items' references.
(Inherited from PFGridViewSettingsData_Items.)
Public propertyLinkTaskToParentWorkflow
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.

(Inherited from PFGridViewSettingsData_Items.)
Public propertyLogger
Gets the logger, used to log any useful warning, error or information in the database.
Public propertyMaxColumns
Gets or sets the maximum number columns that can be shown.
(Inherited from PFGridViewSettingsData.)
Public propertyName
Gets or sets the gridview name.
(Inherited from PFGridViewSettingsData.)
Public propertyNavigationSessionId
Gets the id of the current user session, used to find the corresponding [!:Packflow.Core.PFNavigationSession].
(Inherited from PFGridViewSettingsData.)
Public propertyOpenItemsInFrame
Gets or sets a value indicating whether items should be open in a frame.
(Inherited from PFGridViewSettingsData_Items.)
Public propertyPageNumber
Gets or sets the number of the loaded page.
(Inherited from PFGridViewSettingsData.)
Public propertyPlaceHolderSettings
Gets or sets the placeholder settings.
Public propertyPreviousViewId
Gets or sets the view identifier whose QuickSearchFields are derived.
(Inherited from PFGridViewSettingsData_Items.)
Public propertyQuickSearchFields
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.)
Public propertyQuickSearchTargetingMode
Gets or sets a value indicating how the quicksearch feature is selecting the fields to be filtered.
(Inherited from PFGridViewSettingsData.)
Public propertyRelation
Gets or sets the content relation.

You must also specify the CurrentItem.

Public propertyRelationDirection
Gets or sets the relation direction.
(Inherited from PFGridViewSettingsData_Items.)
Public propertyRelationGuid
Gets or sets the relation guid.
(Inherited from PFGridViewSettingsData_Items.)
Public propertyRelationName
Gets or sets the relation name.
(Inherited from PFGridViewSettingsData_Items.)
Public propertyResultsScope
Gets or sets the results scope: deleted, not deleted or both.
(Inherited from PFGridViewSettingsData.)
Public propertyRetrieveRelatedItemsIds
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.

(Inherited from PFGridViewSettingsData_Items.)
Public propertySelectionModeScope
Gets or sets the scope of available items when the selection mode is active.
(Inherited from PFGridViewSettingsData_Items.)
Public propertySerializedCustomServerFilters
Gets or sets the serialized server-side custom filters.
(Inherited from PFGridViewSettingsData.)
Public propertyShowAvailableValuesInFilters
Gets or sets a value indicating whether available values are proposed when filtering a text/choice/user field (header popup).
(Inherited from PFGridViewSettingsData.)
Public propertyShowOpenFormIcon
Gets or sets a value indicating whether the icon opening the item form is shown (on each row).
(Inherited from PFGridViewSettingsData.)
Public propertySuppression
Gets or sets a value indicating whether the inline suppression is enabled. Note : also depend on PFView setting.
(Inherited from PFGridViewSettingsData_Items.)
Public propertyTargetApplication
Gets the target application.

Changing the TargetView will affect this property.

Public propertyTargetContentType
Gets the target content type.

Changing the TargetView will affect this property.

Public propertyTargetView
Gets or sets the target view.
Public propertyUnlinking
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.
(Inherited from PFGridViewSettingsData_Items.)
Public propertyUrl_Source
Gets or sets the source URL.
(Inherited from PFGridViewSettingsData.)
Public propertyUrl_Template
Gets or sets the template URL PAGE_NAME/APPLICATION_NAME/CONTENTTYPE_NAME/ITEM_ID/?View=VIEW_ID
(Inherited from PFGridViewSettingsData_Items.)
Public propertyUseRelation
Gets or sets a value indicating whether the specified relation should be used from the current item to filter items.

Default value: True.

(Inherited from PFGridViewSettingsData_Items.)
Public propertyUserFilters
Gets or sets the user filters (usually filled client-side with the various filtering features).
(Inherited from PFGridViewSettingsData.)
Public propertyViewId
Gets or sets the target view id.
(Inherited from PFGridViewSettingsData_Items.)
Top
Methods
  NameDescription
Protected methodGetData(String)
Gets a setting metadata.
(Inherited from PFGridViewSettingsData.)
Public methodGetGridViewData
Gets GridView settings properties (does not include placeHolder settings!).
(Inherited from PFGridViewSettingsData.)
Public methodGetRelationNewUrl
Gets an url allowing creating an item through the current relation, with CurrentItem as source.
Public methodSetCustomFilters Obsolete.
Old method. Do not use.
(Inherited from PFGridViewSettingsData.)
Protected methodSetData
Sets the value of a setting
(Inherited from PFGridViewSettingsData.)
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