DocumentClashTests Members

The DocumentClashTests type exposes the following members.

Methods

  Name Description
Public method CopyFrom
Copies the ClashTests and associated data value and replaces the list of entries held in Value.
Public method CreateCopy
Creates a writable copy of the clash tests stored in Value.
Public method CreateReference
Returns a reference to a saved item contained in Value.
Public method Equals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected method Finalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public method GetHashCode
Serves as a hash function for a particular type. GetHashCode()()()() is suitable for use in hashing algorithms and data structures like a hash table.
(Inherited from Object.)
Public method GetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected method MemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public method ResolveGuid
Returns the saved item referenced by a guid.
Public method ResolveReference
Returns the saved item referenced by a SavedItemReference refering to this document part.
Public method TestsAddCopy(ClashTest)
Adds a copy of test to the end of in Value.Tests.
Public method TestsAddCopy(GroupItem, SavedItem)
Adds a copy of item to the end of the given parent item in Value.Tests.
Public method TestsClear
Clears the list of ClashTests in Value.Tests.
Public method TestsClearResults
Removes all ClashResults from the given ClashTest.
Public method TestsCompactAllTests
Removes all resolved ClashResults from all ClashTests.
Public method TestsCompactTest
Removes all resolved ClashResults from one ClashTest.
Public method TestsCopyFrom(IEnumerable<(Of <<'(SavedItem>)>>))
Copies the ClashTests from value and replaces the list of entries held in Value.Tests.
Public method TestsCopyFrom(SavedItemCollection)
Copies the ClashTests from value and replaces the list of entries held in Value.Tests.
Public method TestsEditDisplayName
Sets the display name of a saved item in the document part.
Public method TestsEditResultApprovedBy
Sets the ApprovedBy on an IClashResult stored in the document part. if the result is a ClashResultGroup, then the ApprovedBy field will be set individually on all its children.
Public method TestsEditResultApprovedTime
Sets the ApprovedTime on an IClashResult stored in the document part. if the result is a ClashResultGroup, then the approved time will be set individually on all its children.
Public method TestsEditResultAssignedTo
Sets the AssignedTo on an IClashResult stored in the document part. if the result is a ClashResultGroup, then the AssignedTo field will be set individually on all its children.
Public method TestsEditResultBoundingBox
Sets the BoundingBox on an IClashResult stored in the document part. if the result is a ClashResultGroup, then the BoundingBox field will be set individually on all its children.
Public method TestsEditResultCenter
Sets the Center on an IClashResult stored in the document part. if the result is a ClashResultGroup, then the center will be set individually on all its children.
Public method TestsEditResultComments
Sets the Comments on an IClashResult stored in the document part. if the result is a ClashResultGroup, then the comments are separate from those on its children.
Public method TestsEditResultCreatedTime
Sets the CreatedTime on an IClashResult stored in the document part. if the result is a ClashResultGroup, then the created time will be set individually on all its children.
Public method TestsEditResultDescription
Sets the Description on an IClashResult stored in the document part. if the Result is a ClashResultGroup, then the description will be set individually on all its children.
Public method TestsEditResultDistance
Sets the Distance on an IClashResult stored in the document part. if the result is a ClashResultGroup, then the distance will be set individually on all its children.
Public method TestsEditResultStatus
Sets the Status on an IClashResult stored in the document part. if the result is a ClashResultGroup, then the status will be set individually on all its children.
Public method TestsEditTestFromCopy
Sets all the values of the properties in a clash test with values copied from another test. This enables the properties on a test to be edited without the performance overhead of replacing it (which would involve replacing all contained IClashResults).
Public method TestsInsertCopy(Int32, ClashTest)
Adds a copy of test at the specified index in Value.Tests.
Public method TestsInsertCopy(GroupItem, Int32, SavedItem)
Adds a copy of item at the specified index in the given parent item in Value.Tests.
Public method TestsMove(Int32, Int32)
Move the test from oldIndex to newIndex in Value.Tests.
Public method TestsMove(GroupItem, Int32, GroupItem, Int32)
Move the item at oldIndex in oldParent to position newIndex in newParent where both old and new parents are contained somewhere inside Value.Tests.
Public method TestsRemove(ClashTest)
Remove the given test from Value.Tests.
Public method TestsRemove(GroupItem, SavedItem)
Remove an item from a parent contained somewhere inside Value.Tests.
Public method TestsRemoveAt(Int32)
Remove the test at index in Value.Tests.
Public method TestsRemoveAt(GroupItem, Int32)
Remove the item at index in parent where parent is contained somewhere inside Value.Tests.
Public method TestsReplaceWithCopy(Int32, ClashTest)
Replaces the test at the specified index in Value.Tests with a copy of test.
Public method TestsReplaceWithCopy(GroupItem, Int32, SavedItem)
Replaces the item at the specified index in the given parent item in Value.Tests with a copy of item.
Public method TestsRunAllTests
Runs all ClashTests in the document. Any tests whose situation has not changed since they were last run will be skipped.
Public method TestsRunTest
Runs one ClashTest.
Public method TestsSortResults
Sorts all results in the given test. Sorting is stable and does not reorder where it does not need to.
Public method TestsSortTests
Sorts all tests. Sorting is stable and does not reorder where it does not need to.
Public method ToString
Returns a String that represents the current Object.
(Inherited from Object.)

Properties

  Name Description
Public property Id
The internal identifier for this type of document part.
Public property Tests
A convenience property for accessing the current tests collection. This is equivalent to Value.Tests.
Public property Value
An object referencing root-items for all of the current data involved in defining clash tests.

Events

  Name Description
Public event Changed
Occurs when the TestsData contained in this object have changed.
Public event Changing
Occurs when the TestsData contained in this object is about to change.

See Also

AllMembers.T:Autodesk.Navisworks.Api.Clash.DocumentClashTests