|
|
Namespace: Autodesk.Navisworks.Api.Timeliner
Assembly: Autodesk.Navisworks.Timeliner (in Autodesk.Navisworks.Timeliner.dll)
Syntax
| Visual Basic |
|---|
Public Function TaskCreateIndexPath ( _ task As TimelinerTask _ ) As Collection(Of Integer) |
| C# |
|---|
public Collection<int> TaskCreateIndexPath( TimelinerTask task ) |
| Visual C++ |
|---|
public: Collection<int>^ TaskCreateIndexPath( TimelinerTask^ task ) |
Parameters
- task
- Type: Autodesk.Navisworks.Api.Timeliner..::..TimelinerTask
The task within DocumentTimeliner for which you wish to generate an index path
Remarks
An index path is a series if zero-based indices that specify the position within each Parent, starting with TasksRoot.
Given an IndexPath with indices of 1, 0 and 5, you can find the task by walking the hierarchy starting at TasksRoot:
- Grand Parent at index 1 of TasksRoot.
- Parent at index 0 of Grand Parent.
- Actual Task is at index 5 of the Parent.
You can resolve an index path back to a Task using TaskResolveIndexPath.
WARNING: an index path is volatile and is only valid while no changes occur to tasks within the DocumentTimeliner document part. You should not store index paths for any length of time, but discard them as soon as possible.