IAdmPropertyPatternItemInfo
The IAdmPropertyPatternItemInfo interface provides information about a property pattern item.
Methods
-
Method
-
Description
-
GetConstraints()
-
Returns an array of IAdmPropertyPatternConstraintInfo interfaces, each representing a constraint that is applied to the property.
Properties
-
Property
-
Description
-
PropertyName
-
Gets the name of the object property represented by this entry.
-
DefaultValue
-
Gets the default value for the property.
-
GenerateDefaultValueDuringCreating
-
Gets a value indicating whether the property value must be generated when a directory object is created.
-
GenerateDefaultValueDuringEditing
-
Gets a value indicating whether the property value should be automatically updated during object modification if the
DefaultValue
property contains value references. -
IsPropertyRequired
-
Gets a value indicating whether the property represented by this entry is mandatory.
-
Hint
-
Gets a hint text for the property.
-
PropertyInfoMode
-
Gets a value indicating what to display when the user requests additional information about the property.
-
CustomHelpText
-
Gets a custom description for the property.
Details
GetConstraints()
Returns an array of IAdmPropertyPatternConstraintInfo interfaces, each representing a constraint that is applied to the property.
IAdmPropertyPatternConstraintInfo[] GetConstraints()
PropertyName
Gets the name of the object property represented by this entry. The property gets a string that contains the name of a directory object property as defined in your directory schema (e.g. "department", "cn", "displayName", "manager", etc.).
- Type:
- string
- Access:
- Read-only
DefaultValue
Gets the default value for the property. The value can contain value references.
- Type:
- Object
- Access:
- Read-only
GenerateDefaultValueDuringCreating
Gets a value indicating whether the property value must be generated when a directory object is created.
- Type:
- bool
- Access:
- Read-only
GenerateDefaultValueDuringEditing
Gets a value indicating whether the property value should be automatically updated during object modification if the DefaultValue
property contains value references.
- Type:
- bool
- Access:
- Read-only
Remarks
If set to false
, the property value will be generated only when a directory object is created.
IsPropertyRequired
Gets a value indicating whether the property represented by this entry is mandatory.
- Type:
- bool
- Access:
- Read-only
Hint
Gets or sets a hint text for the property.
- Type:
- string
- Access:
- Read-only
PropertyInfoMode
Gets or sets a value indicating what to display when the user requests additional information about the property.
- Type:
- ADM_PROPERTYPATTERNINFOMODE_ENUM
- Access:
- Read-only
CustomHelpText
Gets or sets a custom description for the property. HTML tags are allowed.
- Type:
- string
- Access:
- Read-only
Requirements
Minimum required version: 2023