PFDashboard Class |
Represents the configuration of a page or equivalent UI containing a structure of widgets.
These widgets are of different generic or custom types and display reports, data views, shortcuts
and various other user features.
Inheritance HierarchyNamespace: Packflow.Core
Assembly: MicaSystems.Packflow.Core (in MicaSystems.Packflow.Core.dll) Version: 1.0.0.0 (3.2.0.306)
SyntaxC#
public sealed class PFDashboard : PFBaseObject
The PFDashboard type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | PFDashboard |
Properties| Name | Description | |
|---|---|---|
 | 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.) |
| 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.) |
| Draft |
Gets or sets the current draft (working copy) of this dashboard
|
| 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.) |
| 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.) |
| Id |
Gets the id identifying this object.
Must be used to find or identify an object because faster than Guid.
(Inherited from PFBaseObject.) |
| 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.
(Inherited from PFBaseObject.) |
| Name |
Gets or sets the dashboard name.
|
| PermissionContext |
Gets an object calculating permissions on demand.
|
| Permissions |
Gets the permission set (RUD permissions) of this item.
(Inherited from PFBaseObject.) |
| Scope |
Gets or sets the scope, describing how this dashboard can be used or managed.
See the SpecificAccesses property for more details.
|
| SecurityLevel |
Gets or sets the dashboard security level.
|
| Site |
Gets the root of the persisted objects tree.
(Inherited from PFBaseObject.) |
| SpecificAccesses |
Gets an object containing visibility and management accesses
to the dashboard when its scope is set to Application.
|
| 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 dashboard.
|
| VersionNumber |
Gets the version number of this object in database. Incremented after each save.
(Inherited from PFBaseObject.) |
| Widgets |
Gets or sets the list of widgets.
|
Methods| Name | Description | |
|---|---|---|
| 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. |
 | GetDashboardUrl |
Gets a dashboard's URL based on its id.
|
| GetLocks |
Gets current locks.
Note : will return an empty list if the object is not yet created. |
| GetValidatedDraft |
Validates the current draft and returns a new PFValidatedDraft instance.
|
| ReleaseLock |
Releases the lock of a given user, if found.
|
| 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.
(Overrides PFBaseObjectSave.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| TryGetLock |
Tries to get a lock for a given user.
|
Fields| Name | Description | |
|---|---|---|
 | FieldName_Name |
Column name in database.
|
| FieldName_Scope |
Column name in database.
|
| FieldName_SecurityLevel |
Column name in database.
|
| FieldName_SerializedDraft |
Column name in database.
|
| FieldName_SerializedWidgets |
Column name in database.
|
| FieldName_SpecificAccesses |
Column name in database.
|
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.) |
See Also