Indicates whether the specified object has been deleted but not committed in the transaction currently in progress.
The persistent object to test.
true, if the specified object is marked as deleted in the transaction currently in progress; otherwise, false.
When an object is deleted, it's not deleted immediately from the database. It's marked as an object to delete and removed from the database the next time the IObjectSpace.CommitChanges method is called.
The IsObjectToDelete method is intended to determine whether a particular object is marked as deleted in the current transaction.