RemovePropertyDefAdmin Method

Description

Deletes the property definition with the specified ID.

Syntax

Visual Basic
Public Sub RemovePropertyDefAdmin( _ ByVal PropertyDef As Long, _ Optional ByVal CopyToAnotherPropertyDef As Boolean = False, _ Optional ByVal TargetPropertyDef As Long = 0, _ Optional ByVal Append As Boolean = False, _ Optional ByVal DeleteFromClassesIfNecessary As Boolean = False _ )

Visual Basic

Public Sub RemovePropertyDefAdmin( _
   ByVal PropertyDef As Long, _
   Optional ByVal CopyToAnotherPropertyDef As Boolean = False, _
   Optional ByVal TargetPropertyDef As Long = 0, _
   Optional ByVal Append As Boolean = False, _
   Optional ByVal DeleteFromClassesIfNecessary As Boolean = False _
)

Parameters

PropertyDef: The ID of the property definition to remove.
CopyToAnotherPropertyDef: Whether to copy the values of the removed property to another property. If True, TargetPropertyDef must be provided.
TargetPropertyDef: The ID of the property definition that should be used when copying the values from the removed property.
Append: Whether to append the values from the removed property to the TargetPropertyDef. If False, the old target values are overwritten.
DeleteFromClassesIfNecessary: If this parameter is True, the reference to the removed property definition is removed from classes. If this parameter is False, the method returns an error if the property definition is referenced by one or more classes.

Remarks

This method is available only if M-Files API is used in the server interface mode.