|
|
The DocumentTimeliner type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
|
Clear |
Restores the Value to its default state, clearing all TimelinerTasks and TimelinerDataSources and initialising
SimulationTaskTypes and SimulationAppearances to their defaults.
|
|
|
DataSourceAddCopy |
Adds a copy of the TimelinerDataSource at the end of the collection to the DocumentTimeliner document part.
|
|
|
DataSourceEditDisplayName |
Changes the name of the TimelinerDataSource at the index specified. This will update all TimelinerTasks that reference this TimelinerDataSource.
|
|
|
DataSourceFindByDisplayName |
Returns the TimelinerDataSource with the DisplayName of "named" or null if no TimelinerDataSource exists with
a DisplayName of named within the DocumentTimeliner document part
|
|
|
DataSourceInsertCopy |
Inserts a copy of the TimelinerDataSource at the specified index within the DocumentTimeliner document part.
|
|
|
DataSourceRemoveAt |
Removes the TimelinerDataSource at the specified index.
|
|
|
DataSourceRemoveByDisplayName |
Removes the TimelinerDataSource from the DocumentTimeliner document part with the name specified.
|
|
|
DataSourceReplaceWithCopy |
Replace the TimelinerDataSource at the index specified with a copy of the TimelinerDataSource specified
This will update all TimelinerTasks that reference the TimelinerDataSource that was replaced.
|
|
|
DataSourcesClear |
Clears all TimelinerDataSources from the DocumentTimeliner document part.
|
|
|
DataSourcesCopyFrom(IEnumerable<(Of <<'(SavedItem>)>>)) |
Copies the TimelinerDataSource to the DocumentTimeliner document part from the IEnumerable
SavedItem collection of TimelinerDataSources.
|
|
|
DataSourcesCopyFrom(SavedItemCollection) |
Copies the TimelinerDataSource to the DocumentTimeliner document part from the
SavedItemCollection of TimelinerDataSources specified.
|
|
|
Dispose()()()() | |
|
Dispose(Boolean) | |
|
|
Equals | (Inherited from Object.) |
|
|
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.) |
|
|
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.) |
|
|
GetType |
Gets the Type of the current instance. (Inherited from Object.) |
|
|
MemberwiseClone |
Creates a shallow copy of the current Object. (Inherited from Object.) |
|
|
SettingsReplaceWithCopy |
Replaces TimelinerSettings within the DocumentTimeliner document part with a copy of the settings specified.
|
|
|
SimulationAppearanceAddCopy |
Adds a copy of the SimulationAppearance at the end of the collection to the DocumentTimeliner document part.
|
|
|
SimulationAppearanceEditDisplayName |
Changes the name of the SimulationAppearance at the index specified. This will update all SimulationTaskTypes that reference this SimulationAppearance.
|
|
|
SimulationAppearanceFindByDisplayName |
Returns the SimulationAppearance with the DisplayName of "named" or null if no SimulationAppearance exists with
a DisplayName of named within the DocumentTimeliner document part
|
|
|
SimulationAppearanceInsertCopy |
Inserts a copy of the SimulationAppearance at the specified index within the DocumentTimeliner document part.
|
|
|
SimulationAppearanceRemoveAt |
Removes the SimulationAppearance at the specified index. This will update all SimulationTaskTypes that reference the SimulationAppearance that was removed.
|
|
|
SimulationAppearanceRemoveByDisplayName |
Removes the SimulationAppearance, with the specified name, from the DocumentTimeliner document part. This will update all SimulationTaskTypes that reference the SimulationAppearance that was removed.
|
|
|
SimulationAppearanceReplaceWithCopy |
Replace the SimulationAppearance at the index specified with a copy of the SimulationAppearance specified. This will update all SimulationTaskTypes that reference the SimulationAppearance that was replaced.
|
|
|
SimulationAppearancesClear |
Clears all SimulationAppearances from the DocumentTimeliner document part.
|
|
|
SimulationAppearancesCopyFrom(IEnumerable<(Of <<'(SavedItem>)>>)) |
Copies the SimulationAppearances to the DocumentTimeliner document part from the IEnumerable SavedItem collection of SimulationAppearances.
See the remarks section of SimulationAppearancesClear for details of how this affects SimulationTaskTypes |
|
|
SimulationAppearancesCopyFrom(SavedItemCollection) |
Copies the SimulationAppearances to the DocumentTimeliner document part from the SavedItemCollection specified.
See the remarks section of SimulationAppearancesClear for details of how this affects SimulationTaskTypes |
|
|
SimulationTaskTypeAddCopy |
Adds a copy of the SimulationTaskType at the end of the collection to the DocumentTimeliner document part.
|
|
|
SimulationTaskTypeEditDisplayName |
Changes the name of the SimulationTaskType at the index specified. This will update all TimelinerTasks that reference this SimulationTaskType.
|
|
|
SimulationTaskTypeFindByDisplayName |
Returns the SimulationTaskType with the DisplayName of "named" or null if no SimulationTaskType exists with
a DisplayName of named within the DocumentTimeliner document part
|
|
|
SimulationTaskTypeInsertCopy |
Inserts a copy of the SimulationTaskType at the specified index within the DocumentTimeliner document part.
|
|
|
SimulationTaskTypeRemoveAt |
Removes the SimulationTaskType at the specified index. This will update all TimelinerTasks that reference the SimulationTaskType that was removed.
|
|
|
SimulationTaskTypeRemoveByDisplayName |
Removes the SimulationTaskType from the DocumentTimeliner document part with the name specified. This will update all TimelinerTasks that reference the SimulationTaskType that was removed.
|
|
|
SimulationTaskTypeReplaceWithCopy |
Replace the SimulationTaskType at the index specified with a copy of the SimulationTaskType specified.
This will update all TimelinerTasks that reference the SimulationTaskType that was replaced.
|
|
|
SimulationTaskTypesClear |
Clears all SimulationTaskTypes from the DocumentTimeliner document part.
|
|
|
SimulationTaskTypesCopyFrom(IEnumerable<(Of <<'(SavedItem>)>>)) |
Copies the SimulationTaskTypes to the DocumentTimeliner document part from the IEnumerable SavedItem collection of SimulationAppearances.
|
|
|
SimulationTaskTypesCopyFrom(SavedItemCollection) |
Copies the SimulationTaskTypes to the DocumentTimeliner document part from the SavedItemCollection specified.
|
|
|
TaskAddCopy(TimelinerTask) |
Adds a copy of the TimelinerTask at the end of the collection to the DocumentTimeliner document part.
|
|
|
TaskAddCopy(GroupItem, TimelinerTask) |
Adds copy of the TimelinerTask specified, appending it to the parent GroupItem specified, within the DocumentTimeliner document part.
|
|
|
TaskCreateIndexPath |
Generates an index path for the specified task. The task must exist in the DocumentTimeliner document part.
|
|
|
TaskEdit(Int32, TimelinerTask) |
Edits the values of the TimelinerTask specified as a child index of TasksRoot
but does not add or modify any children on the existing TimelinerTask
within the DocumentTimelinerDocument part.
|
|
|
TaskEdit(GroupItem, Int32, TimelinerTask) |
Edits the values of the TimelinerTask specified as a child index of the GroupItem specified
but does not add or modify any children on the existing TimelinerTask within the DocumentTimelinerDocument part
|
|
|
TaskEditDisplayName |
Renames the specified TimelinerTask, that must exist within the DocumentTimeliner document part, with the name specified.
|
|
|
TaskInsertCopy(Int32, TimelinerTask) |
Inserts a copy of the TimeLiner task at the index specified on TasksRoot.
|
|
|
TaskInsertCopy(GroupItem, Int32, TimelinerTask) |
Inserts a copy of the TimeLiner task at the index specified on the parent GroupItem item specified.
|
|
|
TaskMergeRebuild |
Merges the TimelinerTask hierarchy specified with the existing hierarchy within
the DocumentTimeliner document part, using the Rebuild methodology.
|
|
|
TaskMergeSynchronize |
Merges the TimelinerTask hierarchy specified with the existing hierarchy within
the DocumentTimeliner document part, using the Synchronise methodology.
|
|
|
TaskMove(Int32, Int32) |
Moves a task on TasksRoot from the oldIndex to the newIndex
|
|
|
TaskMove(GroupItem, Int32, GroupItem, Int32) |
Moves the task specified as child oldIndex of oldParent to the newIndex of the newParent specified.
|
|
|
TaskRemoveAt(Int32) |
Removes the TimelinerTask at the child index of TasksRoot
|
|
|
TaskRemoveAt(GroupItem, Int32) |
Removes the TimelinerTask at the child index of the GroupItem parent
|
|
|
TaskReplaceWithCopy(Int32, TimelinerTask) |
Replace the TimelinerTask at the child index of TasksRoot with a copy of the TimelinerTask specified
|
|
|
TaskReplaceWithCopy(GroupItem, Int32, TimelinerTask) |
Replace the TimelinerTask at the child index of the GroupItem parent, with a copy of the TimelinerTask specified
|
|
|
TaskResolveIndexPath |
Resolves an index path back to the task the index path refers to within the DocumentTimeliner document part.
For information about index paths, see TaskCreateIndexPath.
|
|
|
TasksClear |
Clears all TimelinerTasks from with the DocumentTimeliner document part.
|
|
|
TasksCopyFrom(IEnumerable<(Of <<'(SavedItem>)>>)) |
Copies the TimelinerTasks from the IEnumerable Saveditem collection to the DocumentTimeliner document part - replacing TasksRoot.
|
|
|
TasksCopyFrom(SavedItemCollection) |
Copies the TimelinerTasks from the SavedItemCollection collection to the DocumentTimeliner document part - replacing TasksRoot.
|
|
|
TasksSort |
Sorts the complete TimelinerTask model data hierarchy by the field specified in the direction specified
|
|
TaskSummaryHierarchyRecalculateCosts |
Recalculates the Summaries (see DocumentTimeliner.TaskSummaryRecalculateDates) for the writable task specified.
|
|
|
TaskSummaryHierarchyRecalculateDates |
Recalculates the Summaries (see DocumentTimeliner.TaskSummaryRecalculateDates) for the writable task specified.
|
|
|
TaskSummaryRecalculateCosts |
Causes the DocumentTimeliner document part to inspect all summary tasks and
calculate their start and end costs
|
|
|
TaskSummaryRecalculateDates |
Causes the DocumentTimeliner document part to inspect all summary tasks and
calculate their start and end dates based on the union of all child tasks, including
all children within the hierarchy below task.
|
|
|
TaskTotalTasks |
Returns the number of tasks objects within the TimeLiner hierarchy, including all child and summary tasks.
|
|
|
TimelinerInstance |
Helper to return actual Document Part type for Timeliner as DocumentTimeliner instead of discoverable IDocumentTimeliner document part
|
|
|
ToString | (Inherited from Object.) |
Properties
| Name | Description | |
|---|---|---|
|
DataSources |
Read only SavedItemCollection of all the TimelinerDataSources within the DocumentTimeliner document part.
|
|
|
Settings |
Read only TimelinerSettings object from the DocumentTimeliner document part.
|
|
|
SimulationAppearances |
Read only SavedItemCollection of all the SimulationAppearances within the DocumentTimeliner document part.
|
|
|
SimulationTaskTypes |
Read only SavedItemCollection of all the SimulationTaskTypes within the DocumentTimeliner document part.
|
|
|
Tasks |
Read only SavedItemCollection of the root TimelinerTasks within the document part.
Similar to DocumentTimeliner.TasksRoot but returns a collection that can be enumerated.
|
|
|
TasksRoot |
Read only GroupItem whose children are the root level TimelinerTasks within the DocumentTimeliner document part. Note
that each such child may have it's own TimelinerTask children and they in turn may have TimelinerTask children of their own and so on.
|
|
|
Value |
Property returning the DocumentTimeliner document part's TimelinerData object. This object contains all the
data within the DocumentTimeliner document part. The TimelinerData object encapsulates all the SimulationTaskTypes, SimulationAppearances, TimelinerDataSources and TimelinerTasks within the Document Part.
See the TimelinerData class for more details.
Note that this is not a copy.
|
Events
| Name | Description | |
|---|---|---|
|
Changed |
This event is fired when the DocumentTimeliner element has changed.
Examine the SavedItemChangeEventArgs class for details of
the information supplied by this event.
|
|
|
Changing |
This event is fired when the DocumentTimeliner document part is about to change.
|