PFView Class |
The list of targetable content-types depends on the scope of the view: Site, Application or Content-Type.
Views can be created runtime or from an application's model.
Namespace: Packflow.Core
public class PFView : PFBaseObject
The PFView type exposes the following members.
Name | Description | |
---|---|---|
ApplicationContextIds |
Gets the ids of application contexts allowed to access the view.
| |
BeforeSaveValues |
Gets the previous values of modified fields before the latest Save.
(Inherited from PFBaseObject.)Note: this feature is NOT persisted in the database and therefore only concerns this instance. | |
CanDelete |
Checks if the current permission context allows current user to delete this object.
(Inherited from PFBaseObject.) | |
CanRead |
Checks if the current permission context allows current user to access this object.
(Inherited from PFBaseObject.) | |
CanUpdate |
Checks if the current permission context allows current user to update this object.
(Inherited from PFBaseObject.) | |
ContentTypes |
Gets the list of content-types whose contents are displayed in the view.
| |
Created |
Indicates if this object has been created and is still in database (positive Id).
(Inherited from PFBaseObject.) | |
CreatedAt |
Gets the date of creation of this object in the database.
(Inherited from PFBaseObject.) | |
CreatedBy |
Gets the user who created this object in the database.
(Inherited from PFBaseObject.) | |
Data |
Gets the data collection of this object.
(Inherited from PFBaseObject.) | |
DateObjectCreation |
Gets the date of the creation of this object in memory.
(Inherited from PFManagedObject.) | |
Deleted |
True if this object is flagged as deleted.
(Inherited from PFBaseObject.) | |
DeletedAt |
Date of the suppression of this object.
(Inherited from PFBaseObject.) | |
DeletedBy |
The user who deleted this object.
(Inherited from PFBaseObject.) | |
Description |
Gets or sets the description.
| |
DisableAllLinks |
Gets or sets a value indicating whether all links should be disabled in this view.
Note: this functionality is not currently active. | |
DisplayName |
Gets or sets the display name.
On the application (or content-type) level, this name is translated from the model.
| |
EditorUrl |
Gets the url of the edition page of the view.
| |
EnableVersionMergeToResolveSaveConflicts |
Gets a value indicating whether versions can be merged to resolve save conflicts.
If an object is saved with an older version than the last persisted (in database),
the system will try to merge the versions values (if no conflicts between values)
and will then save the merged item to database.
Note : this setting is NOT persisted and will affect this object instance only.
(Inherited from PFBaseObject.) | |
Exists |
Indicates if this object has been created, still exists in database and is not flagged for suppression.
(Inherited from PFBaseObject.) | |
FixedWidths |
Gets or sets the fixed widths, overriding some of the fields' width.
| |
Guid |
Gets the GUID identifying this object.
Must be used if Id is no more viable, example if content were merged.
(Inherited from PFBaseObject.) | |
HasPendingModifications |
Checks if there is pending changes.
Will check if the values are different from the currently persisted values.
(Inherited from PFBaseObject.) | |
HasPendingPermissionsModifications |
Checks if there is pending modifications in permissions.
Will compute permissions (RUD) and check if there is differences with current persisted permissions.
(Inherited from PFBaseObject.) | |
Hidden |
Gets or sets a value indicating whether this PFView is hidden (in the navigation).
| |
Id |
Gets the id identifying this object.
Must be used to find or identify an object because faster than Guid.
(Inherited from PFBaseObject.) | |
InlineCreation |
Gets or sets a value indicating whether inline creation can be used on this view.
| |
InlineEditing |
Gets or sets a value indicating whether inline edition can be used on this view.
| |
InlineSuppression |
Gets or sets a value indicating whether inline deletion can be used on this view.
| |
IsDefaultView |
Gets a value indicating whether this view is default view for the parent object.
| |
IsModelView |
Gets a value indicating whether this view has been created from an application's model.
| |
KeepBeforeSaveValues |
Gets or sets a value indicating whether
the Save should keep a collection of the modified fields previous values.
(Inherited from PFBaseObject.)Note: this feature is NOT persisted in the database and therefore only concerns this instance. | |
Logger |
Gets the logger, used to log any useful warning, error or information in the database.
(Inherited from PFManagedObject.) | |
LogIdentification |
Gets a technical text representing this object.
(Overrides PFBaseObjectLogIdentification.) | |
ModelView |
Gets the equivalent object of this view in the parent application's model.
| |
ModelViewGuid |
Gets the GUID of this view in the parent application's model.
| |
Name |
Gets or sets the view name.
| |
OrderNo |
Gets or sets a number used to sort the parent content-type's views
when its ViewOrderType is set to OrderNo.
| |
ParentObject |
Gets the parent object (can be a Site, Application or Content-Type).
| |
PermissionContext |
Gets an object calculating permissions on demand.
| |
Permissions |
Gets the permission set (RUD permissions) of this item.
(Inherited from PFBaseObject.) | |
PermissionSetDeleteId |
Id of the permission set for Delete access.
(Inherited from PFBaseObject.) | |
PermissionSetDeleteXml |
XML of serialized permission set for Delete access.
(Inherited from PFBaseObject.) | |
PermissionSetReadId |
Id of the permission set for Read access.
(Inherited from PFBaseObject.) | |
PermissionSetReadXml |
XML of serialized permission set for Read access.
(Inherited from PFBaseObject.) | |
PermissionSetUpdateId |
Id of the permission set for Update access.
(Inherited from PFBaseObject.) | |
PermissionSetUpdateXml |
XML of serialized permission set for Update access.
(Inherited from PFBaseObject.) | |
Pinned |
Gets or sets a value indicating whether the view should appear in the top of the navigation breadcrumbs
views list.
| |
Query |
Gets or sets the query executed to fill the view.
| |
Scope |
Gets the scope of the view, specifying the type of parent object.
| |
Site |
Gets the root of the persisted objects tree.
(Inherited from PFBaseObject.) | |
UpdatedAt |
Gets the date of the last update of this object.
(Inherited from PFBaseObject.) | |
UpdatedBy |
Gets the user who last updated this object in the database.
(Inherited from PFBaseObject.) | |
Url |
Gets the url of the view in the navigation.
| |
VersionNumber |
Gets the version number of this object in database. Incremented after each save.
(Inherited from PFBaseObject.) | |
VisibilityScope |
Gets the rule used to know which users can access the view.
|
Name | Description | |
---|---|---|
CheckFieldsAvailability |
Checks how all fields of multiple content-types can be used in a view.
| |
CustomizeGroupsBeforeRendering |
Customizes the groups list before rendering in the gridview.
Note: it is NOT recommended to customize the list in a view with paging as it could provide the user with unexpected results. Moreover if the paging is enabled and a next page is available, the items list will contain an extra-item at the end. | |
CustomizeGroupTitle(Html, PFField, Object, DictionaryString, Object) |
Customizes the title of a group being displayed in the view.
By default, returns "{GroupFieldDisplay} : {defaultValue}". | |
CustomizeGroupTitle(Html, PFField, PFQuery, Object, DictionaryString, Object) |
Customizes the title of a group being displayed in the view.
By default, customizes some system fields (WorkflowContentTypeId, StateId, ContentTypeId), otherwise returns "{GroupFieldDisplay} : {defaultValue}" (from the other CustomizeGroupTitle method). | |
CustomizeItemsBeforeRendering |
Customizes the items list before rendering in the gridview.
Note: it is NOT recommended to customize the list in a view with paging as it could provide the user with unexpected results. Moreover if the paging is enabled and a next page is available, the items list will contain an extra-item at the end. | |
CustomizeQuery |
Method used to customize the view query.
Override this method to change the query of a view before its execution.
Note: this method is also called during the installation for model views.
| |
Delete |
Flags this object as deleted.
(Inherited from PFBaseObject.)If it fails, throws an error. If the object could not be deleted because it does not yet exist in database, returns false. If successful, returns true. | |
GetFields |
Gets the list of fields displayed in the view.
| |
GetFieldsNames |
Gets the list of field names that will be displayed in the view.
| |
GetNewPermissionContext |
Creates a new permission context based on current object type.
(Overrides PFBaseObjectGetNewPermissionContext.) | |
GetParents |
Gets the structure objects parents of this view.
| |
GetQuickSearchFields |
Gets the list of fields filtered during quick searches on this view.
Note : returned fields must be common to all content-types and filterable with a text. | |
GetSerializedQuery |
Gets the serialized query.
| |
GetSiblings |
Gets the list of views of the parent object.
| |
InitializeLogger |
Use this method to override the way the logger is initialized.
(Inherited from PFBaseObject.) | |
ProcessPermissions |
Compute permissions from permission context and set in data properties.
(Inherited from PFBaseObject.) | |
RunInTransactionArea |
Runs a code with a transaction on object connection.
If there is no current transaction and if the code succeed, transaction is committed.
If an exception is thrown, transaction is rollback.
(Inherited from PFBaseObject.) | |
Save |
Applies the data of this object in the database.
(Inherited from PFBaseObject.) | |
SaveObjectsInDataCollection |
Saves data loaded from temp specialized object
in data properties collection before save or check hasPendingChanges.
(Overrides PFBaseObjectSaveObjectsInDataCollection.) | |
SetFields |
Sets the list of fields to show in the view.
This methods changes the query.
| |
SetFixedWidth |
Forces a width (in pixels) for the specified field.
| |
SubViews_Add |
Adds a new subview.
Currently not active.
| |
SubViews_Get |
Gets the children subviews.
Currently not active.
| |
ToString | Returns a string that represents the current object. (Inherited from Object.) |
Name | Description | |
---|---|---|
FieldName_ApplicationContexts |
Column name in database.
| |
FieldName_DisableAllLinks |
Column name in database.
| |
FieldName_DisplayName |
Column name in database.
| |
FieldName_Hidden |
Column name in database.
| |
FieldName_InlineCreation |
Column name in database.
| |
FieldName_InlineEditing |
Column name in database.
| |
FieldName_InlineSuppression |
Column name in database.
| |
FieldName_ModelView |
Column name in database.
| |
FieldName_ModelViewGuid |
Column name in database.
| |
FieldName_Name |
Column name in database.
| |
FieldName_OrderNo |
Column name in database.
| |
FieldName_Pinned |
Column name in database.
| |
FieldName_VisibilityScope |
Column name in database.
|
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.) |