CoreProperty CoreProperty CoreProperty Class

Definition

Represents the definition for the most fundamental elements of a profile property. Different profile types can share the same core properties.

public ref class CoreProperty sealed : Microsoft::Office::Server::UserProfiles::PropertyBase
public sealed class CoreProperty : Microsoft.Office.Server.UserProfiles.PropertyBase
Public NotInheritable Class CoreProperty
Inherits PropertyBase
Inheritance
CorePropertyCorePropertyCoreProperty

Remarks

Property provides backward compatibility for older custom solutions. For new custom solutions created for Microsoft SharePoint Server 2010 , use CoreProperty, ProfileTypeProperty, and ProfileSubtypeProperty, which provide more granular control over user profile properties.

There are two types of user profile core properties:

  • Regular.Defines the core property data type and the corresponding user profile flags.
  • Section.Core property that serves as a separator for user interface grouping purposes. Because of the nature of the Section type, the following properties are not applicable to it: Type, Length, IsMultivalued, IsAlias, IsSearchable, and Separator. If you try to set a value, an UpdateReadOnlyFieldException is thrown.For regular properties, the Name, Type, Length, and IsMultivalued properties can only be set at creation time. No further update is allowed. If there is an attempt to update, an UpdateReadOnlyFieldException is thrown. The Name property is used to compose the URI of the property. Therefore the name must be a valid URI schema name, otherwise an InvalidValueException is thrown.

Fields

PROFILEURI_PREFIX PROFILEURI_PREFIX PROFILEURI_PREFIX
URI_AboutMe URI_AboutMe URI_AboutMe
URI_AccountName URI_AccountName URI_AccountName
URI_ADGUID URI_ADGUID URI_ADGUID
URI_BlogWebId URI_BlogWebId URI_BlogWebId
URI_Department URI_Department URI_Department
URI_Dottedline URI_Dottedline URI_Dottedline
URI_FeedIdentifier URI_FeedIdentifier URI_FeedIdentifier
URI_FirstName URI_FirstName URI_FirstName
URI_HashTags URI_HashTags URI_HashTags
URI_Interests URI_Interests URI_Interests
URI_JobTitle URI_JobTitle URI_JobTitle
URI_LastName URI_LastName URI_LastName
URI_Manager URI_Manager URI_Manager
URI_Office URI_Office URI_Office
URI_Peers URI_Peers URI_Peers
URI_PersonalSpace URI_PersonalSpace URI_PersonalSpace
URI_PreferredName URI_PreferredName URI_PreferredName
URI_PrivacyActivity URI_PrivacyActivity URI_PrivacyActivity
URI_PrivacyPeople URI_PrivacyPeople URI_PrivacyPeople
URI_PublicSiteRedirect URI_PublicSiteRedirect URI_PublicSiteRedirect
URI_ResourceAccountName URI_ResourceAccountName URI_ResourceAccountName
URI_ResourceSID URI_ResourceSID URI_ResourceSID
URI_Responsibility URI_Responsibility URI_Responsibility
URI_SID URI_SID URI_SID
URI_Skills URI_Skills URI_Skills
URI_SPSDepartment URI_SPSDepartment URI_SPSDepartment
URI_Title URI_Title URI_Title
URI_UserGuid URI_UserGuid URI_UserGuid
URI_UserName URI_UserName URI_UserName
URI_WebSite URI_WebSite URI_WebSite
URI_WorkEmail URI_WorkEmail URI_WorkEmail
URI_WorkPhone URI_WorkPhone URI_WorkPhone

Properties

Description Description Description

Gets or sets the user-facing localized description of the profile core property.

DescriptionLocalized DescriptionLocalized DescriptionLocalized

Retrieves a list of the localized user-facing descriptions for the profile core property.

DisplayName DisplayName DisplayName

Gets or sets the localized display name of the profile core property.

DisplayNameLocalized DisplayNameLocalized DisplayNameLocalized

Retrieves a list of localized user-facing display names for the profile core property.

IsAlias IsAlias IsAlias

Gets or sets a value indicating whether this profile core property serves as the alias of the user.

IsMultivalued IsMultivalued IsMultivalued

Gets or sets a value indicating whether the profile core property can have multiple values.

IsSearchable IsSearchable IsSearchable

Gets or sets a value indicating whether values of this profile core property are indexed by search.

IsSection IsSection IsSection

Gets a value indicating whether this property is a section.

IsUpgrade IsUpgrade IsUpgrade

Gets or sets a value indicating whether this property exists in a previously upgraded installation.

(Inherited from PropertyBase)
IsUpgradePrivate IsUpgradePrivate IsUpgradePrivate

Gets or sets a value indicating whether this property exists in a previously upgraded installation.

(Inherited from PropertyBase)
Length Length Length

Gets or sets the maximum data length of the profile core property.

ManagedPropertyName ManagedPropertyName ManagedPropertyName

Retrieves the managed property name for the profile core property that is used for search queries.

Name Name Name

Gets or sets the name that uniquely identifies this profile core property for this site and in the user profile database.

PartitionID PartitionID PartitionID

Gets the GUID that uniquely identifies the current partition for this property.

(Inherited from PropertyBase)
Separator Separator Separator

Gets or sets the value of the separator used by the user interface for user profile core properties that have multiple values.

TermSet TermSet TermSet

Gets or sets the Microsoft.Sharepoint.Taxonomy.TermSet for this profile core property. This is the term set from which taxonomic terms are retrieved and to which they are stored. The keywords term set is used by default when no term set has been specified.

Type Type Type

Gets or sets the name of the data type of the profile core property.

UseCount UseCount UseCount

Gets the number of times this property is used in the user profiles database.

Methods

Commit() Commit() Commit()

Commits changes made to a profile core property in the user profile database.

Commit(Boolean) Commit(Boolean) Commit(Boolean)

Pushes an updated property definition to the user profile database.

(Inherited from PropertyBase)
GetUserInfoListField(SPSite) GetUserInfoListField(SPSite) GetUserInfoListField(SPSite)

Retrieves the SPField that correlates with this profile core property in the user information list from the specified SPSite.

LoadPropertyDefinition() LoadPropertyDefinition() LoadPropertyDefinition()

Loads the property definition from the database.

(Inherited from PropertyBase)
LoadPropertyDefinition(IDataRecord) LoadPropertyDefinition(IDataRecord) LoadPropertyDefinition(IDataRecord)

Loads the property definition that is defined by the specified data record from the database.

(Inherited from PropertyBase)
LoadPropertyDefinition(SqlCommand, Boolean) LoadPropertyDefinition(SqlCommand, Boolean) LoadPropertyDefinition(SqlCommand, Boolean)

Loads the property definition that is defined by the specified SQL command.

(Inherited from PropertyBase)
PostAddedCleanup() PostAddedCleanup() PostAddedCleanup()

Reloads a property definition and performs any necessary cleanup.

(Inherited from PropertyBase)
PostUpdatedCleanup() PostUpdatedCleanup() PostUpdatedCleanup()

Reloads a property definition and performs any necessary cleanup.

(Inherited from PropertyBase)
UpdateLocalizedData() UpdateLocalizedData() UpdateLocalizedData()

Updates any localized data associated with the property.

(Inherited from PropertyBase)
WriteRemovePropertyAttributesXML(XmlTextWriter) WriteRemovePropertyAttributesXML(XmlTextWriter) WriteRemovePropertyAttributesXML(XmlTextWriter)

Writes to XML the property attributes required for removing.

(Inherited from PropertyBase)
WriteUpdatePropertyAttributesXML(XmlTextWriter, PropertyBase+DBAction) WriteUpdatePropertyAttributesXML(XmlTextWriter, PropertyBase+DBAction) WriteUpdatePropertyAttributesXML(XmlTextWriter, PropertyBase+DBAction)

Writes to XML the property attributes required for updating.

(Inherited from PropertyBase)

Extension Methods

ToJson(Object) ToJson(Object) ToJson(Object)

Applies to