Click or drag to resize

PFGridViewSettings_Objects Class

Represents the settings of a gridview targeting Packflow objects like events, log entries, etc.
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_Objects : PFGridViewSettingsData_Objects

The PFGridViewSettings_Objects type exposes the following members.

Constructors
Properties
  NameDescription
Public propertyAutoOpenGroups
Gets or sets a value indicating whether the first level of groups must be directly opened/loaded.
(Inherited from PFGridViewSettingsData.)
Public propertyCulture
Gets the culture code (two letters format).
(Inherited from PFGridViewSettingsData.)
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 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 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 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 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 propertyObjectsRelation
Gets or sets the objects relation, linking the data with the ParentObject.
Public propertyObjectsRelationName
Gets or sets the objects PFRelation name.

The name of the relation is the name of the relation's property in the parent.

(Inherited from PFGridViewSettingsData_Objects.)
Public propertyObjectsViewName
Gets or sets the objects view name. Attention, this is not a PFView name!

This corresponds to the name passed to PFObjectViewHtmlHelper to select the displayed columns.

(Inherited from PFGridViewSettingsData_Objects.)
Public propertyPageNumber
Gets or sets the number of the loaded page.
(Inherited from PFGridViewSettingsData.)
Public propertyParentObject
Gets or sets the parent object of the shown data.
Public propertyParentObjectReference
Gets or sets a PFObjectReference as text, used to find the parent object of the shown data.
(Inherited from PFGridViewSettingsData_Objects.)
Public propertyPlaceHolderSettings
Gets or sets the placeholder settings.
Public propertyPreviousViewName
Gets or sets the view identifier whose QuickSearchFields are derived.
(Inherited from PFGridViewSettingsData_Objects.)
Public propertyQuery
Gets or sets the PFQuery.
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 propertyResultsScope
Gets or sets the results scope: deleted, not deleted or both.
(Inherited from PFGridViewSettingsData.)
Public propertySerializedCustomServerFilters
Gets or sets the serialized server-side custom filters.
(Inherited from PFGridViewSettingsData.)
Public propertySerializedQuery
Gets or sets the serialized PFQuery.
(Inherited from PFGridViewSettingsData_Objects.)
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 propertyTranslations
Gets the contextual translations provided by Packflow.
Public propertyUrl_Source
Gets or sets the source URL.
(Inherited from PFGridViewSettingsData.)
Public propertyUserFilters
Gets or sets the user filters (usually filled client-side with the various filtering features).
(Inherited from PFGridViewSettingsData.)
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 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