IAdmPropertyPatternItemInfo

The IAdmPropertyPatternItemInfo interface provides information about a property pattern item.

Derived: IAdmUsernamePropertyPatternItemInfo

Methods

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 or sets a value indicating whether to generate a property value when a directory object is updated.

  • IsPropertyRequired

  • Gets or sets a value indicating whether the property represented by this entry must have a value.

  • 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 to generate the property value when a directory object is created.

  • Type:
  • bool
  • Access:
  • Read-only

GenerateDefaultValueDuringEditing

Gets a value indicating whether to generate a property value when a directory object is updated. If set to false, the property value will be generated only when a directory object is created.

  • Type:
  • bool
  • Access:
  • Read-only

Remarks

This property has an effect only if the DefaultValue property contains value references. In other words, if the default property value is based on a template.

IsPropertyRequired

Gets a value indicating whether the property represented by this entry must have a value.

  • Type:
  • bool
  • Access:
  • Read-only

Hint

Gets the hint text for the property.

  • Type:
  • string
  • Access:
  • Read-only

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. HTML tags are allowed.

  • Type:
  • string
  • Access:
  • Read-only

Requirements

Minimum required version: 2023

See also

© Softerra 2022. All rights reserved.
Send feedback