Click or drag to resize

PFSite Properties

The PFSite type exposes the following members.

Properties
  NameDescription
Public propertyActivityLog
Gets a relation allowing to access timer jobs.
Public propertyAdminAccount
Gets the system admin account.
Public propertyAdministrationUrl
Url of the site administration.
Public propertyAdministrationUrl_Roles
Url of the site administration of roles.
Public propertyApplications
All applications installed on this site.
Public propertyBeforeSaveValues
Gets the previous values of modified fields before the latest Save.

Note: this feature is NOT persisted in the database and therefore only concerns this instance.

(Inherited from PFBaseObject.)
Public propertyCanDelete
Checks if the current permission context allows current user to delete this object.
(Inherited from PFBaseObject.)
Public propertyCanRead
Checks if the current permission context allows current user to access this object.
(Inherited from PFBaseObject.)
Public propertyCanUpdate
Checks if the current permission context allows current user to update this object.
(Inherited from PFBaseObject.)
Public propertyCreated
Indicates if this object has been created and is still in database (positive Id).
(Inherited from PFBaseObject.)
Public propertyCreatedAt
Gets the date of creation of this object in the database.
(Inherited from PFBaseObject.)
Public propertyCreatedBy
Gets the user who created this object in the database.
(Inherited from PFBaseObject.)
Public propertyCurrentUser
Gets the current PFUser of the site.
(Overrides PFStructureObjectCurrentUser.)
Public propertyDashboardId
Gets or sets the dashboard id, referencing the default dashboard shown to the user.
Public propertyDashboards
Gets a relation allowing to access all global and personal dashboards.
Public propertyData
Gets the data collection of this object.
(Inherited from PFBaseObject.)
Public propertyDateObjectCreation
Gets the date of the creation of this object in memory.
(Inherited from PFManagedObject.)
Public propertyDeleted
True if this object is flagged as deleted.
(Inherited from PFBaseObject.)
Public propertyDeletedAt
Date of the suppression of this object.
(Inherited from PFBaseObject.)
Public propertyDeletedBy
The user who deleted this object.
(Inherited from PFBaseObject.)
Public propertyDescription
Gets or sets the description of this object.
(Inherited from PFStructureObject.)
Public propertyDisablePerformanceTestAutoStart
Gets or sets a value indicating whether the performance test should be started when the next performance area is encountered.
Public propertyDisplayName
Gets or sets the display name of this object.
(Inherited from PFStructureObject.)
Public propertyEnableVersionMergeToResolveSaveConflicts

Read-only property. Can be modified if overridden.

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.

(Overrides PFBaseObjectEnableVersionMergeToResolveSaveConflicts.)
Public propertyEnableVersionMergeToResolveSaveConflicts_Global
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 all objects loaded from this site instance.
Public propertyEngineVersion
Gets the version of Engine (Core) currently running for this site.
Public propertyEntryRecording
Gets performance test entry used to record this site performances.
Public propertyExists
Indicates if this object has been created, still exists in database and is not flagged for suppression.
(Inherited from PFBaseObject.)
Public propertyGroups
Gets a relation allowing to access all groups with a scope Site.
Public propertyGuid
Gets the GUID identifying this object. Must be used if Id is no more viable, example if content were merged.
(Inherited from PFBaseObject.)
Public propertyHasPendingModifications
Checks if there is pending changes. Will check if the values are different from the currently persisted values.
(Inherited from PFBaseObject.)
Public propertyHasPendingPermissionsModifications
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.)
Public propertyHomeUrl
Home page of this site.
Public propertyId
Gets the id identifying this object. Must be used to find or identify an object because faster than Guid.
(Inherited from PFBaseObject.)
Public propertyInstallerAccount
Gets the system installer account.
Public propertyItemComments
Gets a relation allowing to access comments made on content-type items. It is usually best to use the relation from PFItem.
Public propertyItemsRelations
Gets a relation allowing to access items relations.
Public propertyItemSubscriptions
Gets a relation allowing to access item subscriptions made on content-type items. It is usually best to use the relation from PFItem.
Public propertyKeepBeforeSaveValues
Gets or sets a value indicating whether the Save should keep a collection of the modified fields previous values.

Note: this feature is NOT persisted in the database and therefore only concerns this instance.

(Inherited from PFBaseObject.)
Public propertyLanguageCode
Gets the default language used on this site, in two-letters format.

This language is used for every user using the Default value in their settings.

Public propertyLicence
Gets the licence data.
Public propertyLoggedIdentity
Gets the initial identity used to retrieve this PFSite.
Public propertyLoggedUser
Gets the user having initially loaded this PFSite.
Public propertyLogger
Gets the logger, used to log any useful warning, error or information in the database.
(Inherited from PFManagedObject.)
Public propertyLogIdentification
Gets a technical text representing this object.
(Inherited from PFStructureObject.)
Public propertyLogs
Log entries related to this object.
(Inherited from PFStructureObject.)
Public propertyMembershipProviderAccount
Gets the membership provider account.
Public propertyName
Gets the name of this object.
(Inherited from PFStructureObject.)
Public propertyNavigationMap
Gets the navigation map. This map is used in quick launch bars and breadcrumbs.
Public propertyOrganisationalTypes
Gets a relation allowing to access organisational types.
Public propertyPerformanceEntries
Gets a relation allowing to access performance reports entries.
Public propertyPerformanceReports
Gets a relation allowing to access performance reports.
Public propertyPerformanceTest_IncludeHtmlGenerationDetails
Gets a value indicating whether the performance test will generate messages with HTML generation.
Public propertyPerformanceTest_IncludeItemBindingDetails
Gets a value indicating whether the performance test will include binding operations details.
Public propertyPermissionContext
Gets an object calculating permissions on demand.
Public propertyPermissions
Gets the permission set (RUD permissions) of this item.
(Inherited from PFBaseObject.)
Public propertyStatic memberPersistFileDuringSiteLifeCycle
Gets or sets a value indicating whether a file should be persisted for each site instance. When the site instance is disposed, the file is deleted. Such files are stored in the temp folder of Windows %temp%\PFSites\.
Public propertyPlugins
Gets the site plugins.
Public propertyRunningJobs
Gets a relation allowing to access running timer jobs.
Public propertyRunningPerformanceTestReportId
Gets or sets the id of the currently running test of performance.
Public propertySettings
Gets the site settings.
Public propertySite
Will return the current object.
(Overrides PFBaseObjectSite.)
Public propertyStoredProcedures
Gets a relation allowing to access stored procedures.
Public propertySubViews
Gets a relation allowing to access the subviews of this site's views.
Public propertySupportContact
Gets the address to contact for support.
Public propertyThemeId
Gets or sets the theme id, referencing the theme commonly used on the site.

See GetActiveTheme method for more information.

Public propertyThemes
Gets a relation allowing to access all global and personal themes.
Public propertyTimerJobs
Gets a relation allowing to access timer jobs.
Public propertyUpdatedAt
Gets the date of the last update of this object.
(Inherited from PFBaseObject.)
Public propertyUpdatedBy
Gets the user who last updated this object in the database.
(Inherited from PFBaseObject.)
Public propertyUrl
Url of the navigation of this site.
(Overrides PFStructureObjectUrl.)
Public propertyUserAlternativeIdentities
Gets a relation allowing to access all user alternative identities.
Public propertyUsers
Gets a relation allowing to access the users of this site.
Public propertyVersionNumber
Gets the version number of this object in database. Incremented after each save.
(Inherited from PFBaseObject.)
Public propertyViews
Gets a relation allowing to access all views with a scope Site.
Public propertyWaitOtherThreadsBeforeDisposing
Gets or sets a value indicating whether this site should wait for other threads using this site instance to close before disposing object and connection.

Default value: false.

Top
See Also