2.2.4.17 PropertyInfo

Article
02/15/2022

The PropertyInfo complex type is used to represent schema information about a property.

 <s:complexType name="PropertyInfo">
   <s:sequence>
     <s:element minOccurs="0" maxOccurs="1" name="Name" type="s:string" />
     <s:element minOccurs="0" maxOccurs="1" name="Description" type="s:string" />
     <s:element minOccurs="0" maxOccurs="1" name="DisplayOrder" type="s:int" />
     <s:element minOccurs="0" maxOccurs="1" name="MaximumShown" type="s:int" />
     <s:element minOccurs="0" maxOccurs="1" name="IsAdminEditable" type="s:boolean" />
     <s:element minOccurs="0" maxOccurs="1" name="IsSearchable" type="s:boolean" />
     <s:element minOccurs="0" maxOccurs="1" name="IsSystem" type="s:boolean" />
     <s:element minOccurs="0" maxOccurs="1" name="ManagedPropertyName" type="s:string" />
     <s:element minOccurs="0" maxOccurs="1" name="DisplayName" type="s:string" />
     <s:element minOccurs="0" maxOccurs="1" name="Type" type="s:string" />
     <s:element minOccurs="1" maxOccurs="1" name="AllowPolicyOverride" type="s:boolean" />
     <s:element minOccurs="1" maxOccurs="1" name="DefaultPrivacy" type="tns:Privacy" />
     <s:element minOccurs="1" maxOccurs="1" name="IsAlias" type="s:boolean" />
     <s:element minOccurs="1" maxOccurs="1" name="IsColleagueEventLog" type="s:boolean" />
     <s:element minOccurs="1" maxOccurs="1" name="IsRequired" type="s:boolean" />
     <s:element minOccurs="1" maxOccurs="1" name="IsUserEditable" type="s:boolean" />
     <s:element minOccurs="1" maxOccurs="1" name="IsVisibleOnEditor" type="s:boolean" />
     <s:element minOccurs="1" maxOccurs="1" name="IsVisibleOnViewer" type="s:boolean" />
     <s:element minOccurs="1" maxOccurs="1" name="IsReplicable" type="s:boolean" />
     <s:element minOccurs="1" maxOccurs="1" name="UserOverridePrivacy" type="s:boolean" />
     <s:element minOccurs="1" maxOccurs="1" name="Length" type="s:int" />
     <s:element minOccurs="1" maxOccurs="1" name="IsImported" type="s:boolean" />
     <s:element minOccurs="1" maxOccurs="1" name="IsMultiValue" type="s:boolean" />
     <s:element minOccurs="1" maxOccurs="1" name="ChoiceType" type="tns:ChoiceTypes" />
     <s:element minOccurs="0" maxOccurs="1" name="TermSetId" nillable="true" type="s1:guid" />
   </s:sequence>
 </s:complexType>

Name: A string that specifies the name of the property.

Description: A string that specifies a description of the property.

DisplayOrder: An integer that specifies the index at which this property is normally displayed.

MaximumShown: An integer that specifies the maximum number of values shown for this property.

IsAdminEditable: A Boolean that if set to true specifies that this property can be edited by an administrator and is set to false otherwise.

IsSearchable: A Boolean that if set to true specifies that this property is searchable and is set to false otherwise.

IsSystem: A Boolean that if set to true specifies that this is a core system property and is set to false otherwise.

ManagedPropertyName: If specified, a string that is used in URL encodings when searching for other properties with the same value.

DisplayName: A string that specifies the display name of the property.Type: A string that specifies the value specifying the type of the user profile property.

AllowPolicyOverride: A Boolean that if set to true specifies that the site collection administrator is allowed to override the default policy setting assigned to the user profile privacy policy and is set to false otherwise.

DefaultPrivacy: A value indicating the default privacy setting of the property which MUST be a value listed in the Privacy (section 2.2.5.4) enumeration.

IsAlias: A Boolean that if set to true specifies that this property serves as an alias property of the user profile for user search purposes and is set to false otherwise.

IsColleagueEventLog: A Boolean that if set to true specifies that this property is displayed on the Colleague Tracker Web Part and is set to false otherwise

IsRequired: A Boolean that if set to true specifies that this property is required when saving its value to a user profile and is set to false otherwise.

IsUserEditable: A Boolean value that if set to true specifies that this property is editable and is set to false otherwise

IsVisibleOnEditor: A Boolean that if set to true specifies that this property is visible when a user edits his or her user profile from his or her profile site and is set to false otherwise.

IsVisibleOnViewer: A Boolean value that if set to true specifies this property is visible on the default profile site and is set to false otherwise.

IsReplicable: A Boolean value that if set to true specifies this property is replicable and is set to false otherwise.

UserOverridePrivacy: A Boolean that if set to true specifies that the system enables the user to override the default protection level assigned to the privacy policy and is set to false otherwise.

Length: An integer that specifies the maximum length of the value of the property.

IsImported: A Boolean value that if set to true specifies that this property is imported to the protocol server from an external data source and is set to false otherwise.

IsMultiValue: A Boolean that if set to true specifies that the property can have multiple values and is set to false otherwise.

ChoiceType: A ChoiceTypes (section 2.2.5.1) value which indicates the state of the property's list of choices.

TermSetID: If specified, a GUID that corresponds to a taxonomy term set that backs the value of the property.

2.2.4.17 PropertyInfo

Additional resources