IAdmPropertyPatternItem

The IAdmPropertyPatternItem interface represents a property pattern entry.

Inheritance: IAdmTop

Derived: IAdmUsernamePropertyPatternItem

Methods

Properties

  • Property

  • Description

  • PropertyName

  • Gets or sets the name of the object property represented by this entry.

  • DefaultValue

  • Gets or sets the default value for the property.

  • GenerateDefaultValueDuringCreating

  • Gets or sets 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 or sets a hint text for the property.

  • PropertyInfoMode

  • Gets or sets a value indicating what to display when the user requests additional information about the property.

  • CustomHelpText

  • Gets or sets a custom description for the property.

Details

GetConstraints()

Returns the IAdmPropertyPatternConstraints interface that represents a collection of constrains for the property.

IAdmPropertyPatternConstraints GetConstraints()

SetConstraints()

Sets a collection of constraints for the property represented by this entry.

void SetConstraints(IAdmPropertyPatternConstraints constraints)

Remarks

This method does not save the changes to the directory. Call IADs::SetInfo to update the constrains in the directory.

PropertyName

Gets or sets the name of the object property represented by this entry. The property must be set to 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/Write

DefaultValue

Gets or sets the default value for the property. You can use value references in the value.

  • Type:
  • Object
  • Access:
  • Read/Write

GenerateDefaultValueDuringCreating

Gets or sets a value indicating whether to generate the property value when a directory object is created.

  • Type:
  • bool
  • Access:
  • Read/Write

GenerateDefaultValueDuringEditing

Gets or sets 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/Write

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 or sets a value indicating whether the property represented by this entry must have a value.

  • Type:
  • bool
  • Access:
  • Read/Write

Hint

Gets or sets a hint text for the property.

  • Type:
  • string
  • Access:
  • Read/Write

PropertyInfoMode

Gets or sets a value indicating what to display when the user requests additional information about the property.

CustomHelpText

Gets or sets a custom description for the property. HTML tags are allowed.

  • Type:
  • string
  • Access:
  • Read/Write

Requirements

Minimum required version: 2023

See also

© Softerra 2022. All rights reserved.
Send feedback