WklGantt

Dim myWklGantt As WklGantt
Set myWklGantt = Me!ControlName.Object

A Gantt chart: the tasks as a hierarchical datasheet with a timeline of bars, milestones, summary tasks and dependencies, with working calendar and scheduling.

None

WklGantt has every member and event of `WklTreeList`: binding, columns, editing, master-detail, export. Each record is a task; a record with child records is a summary task whose start, finish and progress are computed from its subtasks.

The task fields are named by properties (StartField, FinishField or DurationField, ProgressField …). Dependencies come from a table (DependencySource) or from a text field of the successor (PredecessorsField, for example 3EA+2;5AA); segments of split tasks, resources and free days come from further tables. Durations and lags count working time of the calendar (WorkDays, WorkHours, HolidaySource) in days or hours (DurationUnit).

ScheduleMode decides what happens when a task changes: wgsManual keeps every other task where it is and reports broken dependencies in Violations; wgsAutomatic schedules the dependent tasks as soon as their dependencies and constraints allow, as common project tools do. Tasks without dependencies and constraints are never moved.

The whole tree is always loaded; LazyLoad has no effect. Without SortField and with SortOrder = wsoAscending, sibling tasks are ordered by their start, then by text; a sorted column or a SortField wins.

The control shows the task list on the left and the timeline on the right, in form view and in design view (with LivePreview): a two-row time scale, non-working time shaded, bars with their completed part, split tasks, summary tasks, milestones, baselines (ShowBaseline), deadlines, labels, dependency arrows (broken ones red and dashed), the critical path (ShowCriticalPath), lines for today and the status date, and the timeline strip (ShowTimeline). One vertical scroll bar right of the timeline moves both parts. Ctrl+mouse wheel zooms, Shift+mouse wheel scrolls the time; the shortcut menu of the timeline offers zoom, today and the display switches. Drag the gap between list and timeline to set SplitterPosition.

Change tasks with the mouse in the timeline (AllowTaskEditing): drag a bar to move the task, its left or right edge to change start or finish, and the handle at the end of the completed part (lower half of the bar) to change the progress. Draw a dependency (AllowLinkEditing) from the small zone just before or after a bar to another bar; where you drop it decides the type: from the end to the left half of the target is finish-to-start (EA), to the right half finish-to-finish (EE); from the start, start-to-start (AA) or start-to-finish (AE). Right-click an arrow to delete its dependency. While you drag, a dashed bar and a tooltip show the result; press Esc to cancel. Moves snap to whole days (whole hours at hour zoom when DurationUnit is hours).

Every change of the user, in the timeline or in the start, finish, duration and progress columns, raises BeforeTaskChange (or BeforeLinkAdd, BeforeLinkDelete), is written as one transaction together with the tasks automatic scheduling moved and the summary values (UpdateSummaries), and raises AfterTaskChange (or AfterLinkAdd, AfterLinkDelete). Cancel writes nothing; an error goes to DataError. The same changes made by code (SetTaskDates, LinkTasks, CellValue …) raise none of these events.

The shortcut menus of list and timeline offer the planning commands of common project tools for the selected tasks: link them in display order (Ctrl+F2, finish-to-start), unlink them (Ctrl+Shift+F2; one task: all its dependencies, several: those between them), indent and outdent them (Alt+Shift+Right/Left), assign resources in a dialog, mark them 0, 25, 50, 75 or 100 % complete, split the task under the mouse there (timeline; needs SegmentSource, the work resumes one working day later), switch automatic scheduling (ScheduleMode, for the open form only) and reschedule the whole project. Ctrl+Shift+F5 scrolls the timeline to the selected task. Each command raises the same events as the mouse; rescheduling the project writes with BeforeUpdate/AfterUpdate only. The tooltip of a bar names the broken dependencies, constraints and deadlines of its task.

Set the chart up in its designer (row Custom [...] of the property sheet (Opening the designer), or the […] button of any chart property): next to the pages of WklTreeList it has the pages Tasks (task fields, progress scale, date change mode, summaries), Dependencies (dependency table or predecessor text, segments), Resources (resource text or tables), Calendar and scheduling (scheduling mode, unit, working days and hours, free days), and Timeline (zoom, period, display, colors, editing with the mouse). The field lists come from the database; a live preview shows list and timeline with the real data. OK writes every changed property into the form.

The exports of the list include the chart. ExportToXlsx with wemWysiwyg writes the timeline as real worksheet cells right of the list: one Excel column per unit of Zoom, the two-row time scale as merged header cells, task bars as filled cells in the bar color (completed part darker), summary tasks as a thick line, milestones as ◆, free days shaded and today marked; the list stays frozen while the timeline scrolls. Dependency arrows, baselines, deadlines and the status line have no cell form and are left out. The data exports (ExportToXlsx with wemDataAware, ExportToXml, ExportToJson) add start, finish, duration, progress, predecessors and resources as columns where no column shows them already, and XML and JSON list the dependencies under links. ExportToImage and ExportToPdf draw the chart as a picture, and ExportToProject writes the plan as Microsoft Project XML. The shortcut menu “Exportieren …” offers PDF, PNG and MS Project XML as well.

ImportFromProject reads a Microsoft Project XML file back and matches it with the tables: a task that finds its record changes it, the others are added, dependencies and resource assignments follow per pair, and free days are added to HolidaySource. Set ProjectUidField to keep the Project UID of every task; then a plan that came from Project keeps its identity in both directions. The shortcut menu “Aus MS Project importieren …” opens the import dialog, which shows what would be written before anything is.

Screen readers and test tools see the task list as a data grid (as WklTreeList) and the timeline as a list named after the control (“List1 timeline”) with one item per bar: its name is the task, its help text the text of the bar's tooltip (dates, duration, progress, resources, slack, broken rules); selecting an item selects the task. Layout (inherited) also keeps the zoom, the splitter position and the first visible day of the timeline.

An ActiveX control: inserted into a form in design view (Form Design › Controls › ActiveX Controls); reports are not supported. VBA reaches it through the Object property of the control, where ControlName is the name of the control on the form.

With Me!Gantt1.Object
    .RecordSource = "tblTasks"
    .KeyField = "ID": .ParentField = "ParentID": .TextField = "Name"
    .StartField = "Start": .FinishField = "Finish": .ProgressField = "Done"
    .DependencySource = "tblLinks": .PredecessorField = "FromID": .SuccessorField = "ToID"
    .ScheduleMode = wgsAutomatic
    .LinkTasks 3, 4, wglFinishToStart, 1
    Debug.Print .TaskStart(4), .TaskFinish(4), .IsCritical(4)
End With

WklGantt inherits every member of `WklTreeList`, which inherits from `WklTreeView`; inherited members are described on the base class's page.

Property Get StartField() As String
Property Let StartField(RHS As String)

Gets or sets the field with the start of a task.

None

Property value: String – A field name of RecordSource.

A task without start has no bar. With DurationUnit = wguDays the time of day is ignored.

Read/write.

None

Declared by WklGantt.

Property Get FinishField() As String
Property Let FinishField(RHS As String)

Gets or sets the field with the finish of a task.

None

Property value: String – A field name; empty to compute the finish from DurationField.

In days the finish is the last working day of the task: a task from Monday to Monday lasts one day. A finish before the start is reported in Issues.

Read/write.

None

Declared by WklGantt.

Property Get DurationField() As String
Property Let DurationField(RHS As String)

Gets or sets the field with the duration, used when FinishField is empty.

None

Property value: String – A field name; the duration counts working time in DurationUnit. A duration of 0 makes a milestone.

Read/write.

None

Declared by WklGantt.

Property Get ProgressField() As String
Property Let ProgressField(RHS As String)

Gets or sets the field with the progress of a task.

None

Property value: String – A field name; the range is set by ProgressScale.

A task at 100 % is complete: automatic scheduling leaves it where it is.

Read/write.

None

Declared by WklGantt.

Property Get MilestoneField() As String
Property Let MilestoneField(RHS As String)

Gets or sets the Yes/No field that marks a milestone.

None

Property value: String – A field name; empty to treat tasks with duration 0 as milestones.

Read/write.

None

Declared by WklGantt.

Property Get ConstraintTypeField() As String
Property Let ConstraintTypeField(RHS As String)

Gets or sets the field with the constraint of a task.

None

Property value: String – A field name; the field holds a `WklGanttConstraint` value.

In automatic mode a task moved by SetTaskDates gets wgcStartNoEarlierThan with its new start, so the move holds; the constraint is written when this field and ConstraintDateField are set.

Read/write.

None

Declared by WklGantt.

Property Get ConstraintDateField() As String
Property Let ConstraintDateField(RHS As String)

Gets or sets the field with the date of the constraint.

None

Property value: String – A field name; a start date for the start constraints, a finish date for the finish constraints.

Read/write.

None

Declared by WklGantt.

Property Get BaselineStartField() As String
Property Let BaselineStartField(RHS As String)

Gets or sets the field with the start of the baseline (the planned start).

None

Property value: String – A field name.

Read/write.

None

Declared by WklGantt.

Property Get BaselineFinishField() As String
Property Let BaselineFinishField(RHS As String)

Gets or sets the field with the finish of the baseline (the planned finish).

None

Property value: String – A field name.

Read/write.

None

Declared by WklGantt.

Property Get DeadlineField() As String
Property Let DeadlineField(RHS As String)

Gets or sets the field with the deadline of a task.

None

Property value: String – A field name; a task that finishes later is listed in Violations.

Read/write.

None

Declared by WklGantt.

Property Get TimelineField() As String
Property Let TimelineField(RHS As String)

Gets or sets the Yes/No field that shows a task on the timeline strip above the chart.

None

Property value: String – A field name.

Read/write.

None

Declared by WklGantt.

Property Get BarColorField() As String
Property Let BarColorField(RHS As String)

Gets or sets the field with the bar color of a task.

None

Property value: String – A field name; the field holds an Access color number. Null uses BarColor.

Read/write.

None

Declared by WklGantt.

Property Get PredecessorsField() As String
Property Let PredecessorsField(RHS As String)

Gets or sets the text field with the predecessors of a task, used when DependencySource is empty.

None

Property value: String – A field name.

The text lists predecessor keys separated by ;, each with an optional type (EA finish-to-start, AA, EE, AE; English FS, SS, FF, SF are read as well) and an optional lag (+2, -1, +4h, +2t): 3EA+2;5AA;7. A key that contains a separator, sign or ends in a type is written in double quotes. Works for single-field keys only.

Read/write.

None

Declared by WklGantt.

Property Get DependencySource() As String
Property Let DependencySource(RHS As String)

Gets or sets the table, query or SQL statement with one dependency per record.

None

Property value: String – The name of a table or query, or an SQL statement; empty when PredecessorsField is used.

Needs PredecessorField and SuccessorField; LinkTypeField and LagField are optional. LinkTasks and UnlinkTasks add and delete records here.

Read/write.

None

Declared by WklGantt.

Property Get PredecessorField() As String
Property Let PredecessorField(RHS As String)

Gets or sets the field of the dependencies with the key of the predecessor.

None

Property value: String – A field name; for a composite key the fields separated by ;, in the order of KeyField.

Read/write.

None

Declared by WklGantt.

Property Get SuccessorField() As String
Property Let SuccessorField(RHS As String)

Gets or sets the field of the dependencies with the key of the successor.

None

Property value: String – A field name; for a composite key the fields separated by ;.

Read/write.

None

Declared by WklGantt.

Property Get LinkTypeField() As String
Property Let LinkTypeField(RHS As String)

Gets or sets the field of the dependencies with the type.

None

Property value: String – A field name; the field holds a `WklGanttLinkType` value. Empty: every dependency is finish-to-start.

Read/write.

None

Declared by WklGantt.

Property Get LagField() As String
Property Let LagField(RHS As String)

Gets or sets the field of the dependencies with the lag.

None

Property value: String – A field name; the lag counts working time in DurationUnit, negative for an overlap.

Read/write.

None

Declared by WklGantt.

Property Get SegmentSource() As String
Property Let SegmentSource(RHS As String)

Gets or sets the table, query or SQL statement with the segments of split tasks.

None

Property value: String – The name of a table or query, or an SQL statement.

One record per worked part of a task. A task with segments takes its start and finish from them. SplitTask writes the segments here.

Read/write.

None

Declared by WklGantt.

Property Get SegmentTaskField() As String
Property Let SegmentTaskField(RHS As String)

Gets or sets the field of the segments with the key of the task.

None

Property value: String – A field name; for a composite key the fields separated by ;.

Read/write.

None

Declared by WklGantt.

Property Get SegmentStartField() As String
Property Let SegmentStartField(RHS As String)

Gets or sets the field of the segments with the start.

None

Property value: String – A field name.

Read/write.

None

Declared by WklGantt.

Property Get SegmentFinishField() As String
Property Let SegmentFinishField(RHS As String)

Gets or sets the field of the segments with the finish.

None

Property value: String – A field name.

Read/write.

None

Declared by WklGantt.

Property Get ResourcesField() As String
Property Let ResourcesField(RHS As String)

Gets or sets the text field with the resources of a task, used when AssignmentSource is empty.

None

Property value: String – A field name.

The text lists names separated by ;, each with an optional share in percent: Miller;Smith[50%]. With ResourceSource the names are looked up there; without it, every name is a resource.

Read/write.

None

Declared by WklGantt.

Property Get ResourceSource() As String
Property Let ResourceSource(RHS As String)

Gets or sets the table, query or SQL statement with the resources.

None

Property value: String – The name of a table or query, or an SQL statement.

Read/write.

None

Declared by WklGantt.

Property Get ResourceKeyField() As String
Property Let ResourceKeyField(RHS As String)

Gets or sets the field of the resources with the key.

None

Property value: String – A field name.

Read/write.

None

Declared by WklGantt.

Property Get ResourceNameField() As String
Property Let ResourceNameField(RHS As String)

Gets or sets the field of the resources with the name.

None

Property value: String – A field name.

Read/write.

None

Declared by WklGantt.

Property Get ResourceColorField() As String
Property Let ResourceColorField(RHS As String)

Gets or sets the field of the resources with a bar color.

None

Property value: String – A field name; optional.

Read/write.

None

Declared by WklGantt.

Property Get AssignmentSource() As String
Property Let AssignmentSource(RHS As String)

Gets or sets the table, query or SQL statement with the assignments of resources to tasks.

None

Property value: String – The name of a table or query, or an SQL statement.

Read/write.

None

Declared by WklGantt.

Property Get AssignmentTaskField() As String
Property Let AssignmentTaskField(RHS As String)

Gets or sets the field of the assignments with the key of the task.

None

Property value: String – A field name; for a composite key the fields separated by ;.

Read/write.

None

Declared by WklGantt.

Property Get AssignmentResourceField() As String
Property Let AssignmentResourceField(RHS As String)

Gets or sets the field of the assignments with the key of the resource.

None

Property value: String – A field name.

Read/write.

None

Declared by WklGantt.

Property Get AssignmentUnitsField() As String
Property Let AssignmentUnitsField(RHS As String)

Gets or sets the field of the assignments with the share of the resource.

None

Property value: String – A field name; the share in percent, 100 when the field is empty or Null.

Read/write.

None

Declared by WklGantt.

Property Get HolidaySource() As String
Property Let HolidaySource(RHS As String)

Gets or sets the table, query or SQL statement with the free days.

None

Property value: String – The name of a table or query, or an SQL statement.

Read/write.

None

Declared by WklGantt.

Property Get HolidayField() As String
Property Let HolidayField(RHS As String)

Gets or sets the date field of the free days.

None

Property value: String – A field name.

Read/write.

None

Declared by WklGantt.

Property Get DurationUnit() As WklGanttDurationUnit
Property Let DurationUnit(RHS As WklGanttDurationUnit)

Gets or sets whether durations and lags count working days or working hours.

None

Property value: `WklGanttDurationUnit` – A `WklGanttDurationUnit` constant. Default: wguDays.

Read/write.

None

Declared by WklGantt.

Property Get WorkDays() As Long
Property Let WorkDays(RHS As Long)

Gets or sets the working weekdays.

None

Property value: Long – The sum of 1 (Sunday), 2 (Monday), 4 (Tuesday), 8 (Wednesday), 16 (Thursday), 32 (Friday), 64 (Saturday). Default: 62, Monday to Friday.

Read/write.

None

Declared by WklGantt.

Property Get WorkHours() As String
Property Let WorkHours(RHS As String)

Gets or sets the working hours of a working day.

None

Property value: String – Spans separated by ;, for example 08:00-12:00;13:00-17:00 (default). The end of a span is not working time.

Read/write.

None

Declared by WklGantt.

Property Get ScheduleMode() As WklGanttScheduleMode
Property Let ScheduleMode(RHS As WklGanttScheduleMode)

Gets or sets what happens to dependent tasks when a task changes.

None

Property value: `WklGanttScheduleMode` – A `WklGanttScheduleMode` constant. Default: wgsManual.

Read/write.

None

Declared by WklGantt.

Property Get DateChangeMode() As WklGanttDateChangeMode
Property Let DateChangeMode(RHS As WklGanttDateChangeMode)

Gets or sets whether a new start entered in the grid moves the task or changes its duration.

None

Property value: `WklGanttDateChangeMode` – A `WklGanttDateChangeMode` constant. Default: wgdMoveTask.

Read/write.

None

Declared by WklGantt.

Property Get UpdateSummaries() As Boolean
Property Let UpdateSummaries(RHS As Boolean)

Gets or sets whether the computed start, finish and progress of summary tasks are written into their records.

None

Property value: Boolean – True (default) to write them with every change, so queries and reports see the right values.

Read/write.

None

Declared by WklGantt.

Property Get ProgressScale() As WklGanttProgressScale
Property Let ProgressScale(RHS As WklGanttProgressScale)

Gets or sets the range of ProgressField and TaskProgress.

None

Property value: `WklGanttProgressScale` – A `WklGanttProgressScale` constant. Default: wgpPercent (0 to 100).

Read/write.

None

Declared by WklGantt.

Property Get LeftTextField() As String
Property Let LeftTextField(RHS As String)

Gets or sets the field whose value is shown left of the bar.

None

Property value: String – A field name.

Read/write.

None

Declared by WklGantt.

Property Get RightTextField() As String
Property Let RightTextField(RHS As String)

Gets or sets the field whose value is shown right of the bar.

None

Property value: String – A field name; empty to show the resources of the task.

Read/write.

None

Declared by WklGantt.

Property Get InsideTextField() As String
Property Let InsideTextField(RHS As String)

Gets or sets the field whose value is shown inside the bar.

None

Property value: String – A field name.

Read/write.

None

Declared by WklGantt.

Property Get Zoom() As WklGanttZoom
Property Let Zoom(RHS As WklGanttZoom)

Gets or sets the time unit of a column of the timeline.

None

Property value: `WklGanttZoom` – A `WklGanttZoom` constant. Default: wgzDays.

Read/write.

None

Declared by WklGantt.

Property Get TimescaleWidth() As Long
Property Let TimescaleWidth(RHS As Long)

Gets or sets the width of a timeline column.

None

Property value: Long – Percent of the default width, 25 to 400. Default: 100.

Read/write.

None

Declared by WklGantt.

Property Get ChartStart() As Variant
Property Let ChartStart(RHS As Variant)

Gets or sets the first date of the timeline.

None

Property value: Variant – A date, or Null to start at the earliest task (default).

Read/write.

None

Declared by WklGantt.

Property Get ChartFinish() As Variant
Property Let ChartFinish(RHS As Variant)

Gets or sets the last date of the timeline.

None

Property value: Variant – A date, or Null to end at the latest task (default).

Read/write.

None

Declared by WklGantt.

Property Get SplitterPosition() As Long
Property Let SplitterPosition(RHS As Long)

Gets or sets the width of the task list left of the timeline.

None

Property value: Long – Twips; 0 for half of the control (default).

Read/write.

None

Declared by WklGantt.

Property Get ShowCriticalPath() As Boolean
Property Let ShowCriticalPath(RHS As Boolean)

Gets or sets whether critical tasks are drawn in CriticalColor.

None

Property value: Boolean – True to highlight the critical path.

Read/write.

None

Declared by WklGantt.

Property Get ShowBaseline() As Boolean
Property Let ShowBaseline(RHS As Boolean)

Gets or sets whether the baseline is drawn below the bars.

None

Property value: Boolean – True to show baselines.

Read/write.

None

Declared by WklGantt.

Property Get ShowTimeline() As Boolean
Property Let ShowTimeline(RHS As Boolean)

Gets or sets whether the timeline strip is shown above the chart.

None

Property value: Boolean – True to show the tasks of TimelineField over the whole project.

Read/write.

None

Declared by WklGantt.

Property Get ShowToday() As Boolean
Property Let ShowToday(RHS As Boolean)

Gets or sets whether a line marks today.

None

Property value: Boolean – True (default) to show the line.

Read/write.

None

Declared by WklGantt.

Property Get StatusDate() As Variant
Property Let StatusDate(RHS As Variant)

Gets or sets the status date, drawn as a vertical line.

None

Property value: Variant – A date, or Null for none (default).

Read/write.

None

Declared by WklGantt.

Property Get BarColor() As OLE_COLOR
Property Let BarColor(RHS As OLE_COLOR)

Gets or sets the color of task bars.

None

Property value: OLE_COLOR – An Access color number.

Read/write.

None

Declared by WklGantt.

Property Get SummaryColor() As OLE_COLOR
Property Let SummaryColor(RHS As OLE_COLOR)

Gets or sets the color of summary bars.

None

Property value: OLE_COLOR – An Access color number.

Read/write.

None

Declared by WklGantt.

Property Get MilestoneColor() As OLE_COLOR
Property Let MilestoneColor(RHS As OLE_COLOR)

Gets or sets the color of milestones.

None

Property value: OLE_COLOR – An Access color number.

Read/write.

None

Declared by WklGantt.

Property Get CriticalColor() As OLE_COLOR
Property Let CriticalColor(RHS As OLE_COLOR)

Gets or sets the color of critical tasks.

None

Property value: OLE_COLOR – An Access color number; used with ShowCriticalPath.

Read/write.

None

Declared by WklGantt.

Property Get AllowTaskEditing() As Boolean
Property Let AllowTaskEditing(RHS As Boolean)

Gets or sets whether bars can be moved and resized and their progress dragged.

None

Property value: Boolean – True (default) to allow it.

Read/write.

None

Declared by WklGantt.

Property Get AllowLinkEditing() As Boolean
Property Let AllowLinkEditing(RHS As Boolean)

Gets or sets whether dependencies can be drawn and deleted in the timeline.

None

Property value: Boolean – True (default) to allow it.

Read/write.

None

Declared by WklGantt.

Property Get TaskStart(ByVal Key As Variant) As Variant

Returns the start of a task as the table stores it.

Property value: Variant – The start; Null when the task has no bar. For a summary task the earliest start of its subtasks.

Read-only.

None

Declared by WklGantt.

Property Get TaskFinish(ByVal Key As Variant) As Variant

Returns the finish of a task as the table stores it.

Property value: Variant – The finish; Null when the task has no bar. In days the last working day.

Read-only.

None

Declared by WklGantt.

Property Get TaskDuration(ByVal Key As Variant) As Double

Returns the duration of a task.

Property value: Double – The working time in DurationUnit, without the gaps of a split task; 0 for a milestone.

Read-only.

None

Declared by WklGantt.

Property Get TaskProgress(ByVal Key As Variant) As Double
Property Let TaskProgress(ByVal Key As Variant, RHS As Double)

Gets or sets the progress of a task.

Property value: Double – The progress in the range of ProgressScale. Setting it writes ProgressField and the summary tasks.

Read/write.

None

Declared by WklGantt.

Property Get TaskSlack(ByVal Key As Variant) As Double

Returns the total float of a task.

Property value: Double – The working time in DurationUnit the task can finish later without moving the end of the project or breaking a constraint; 0 or less for a critical task. For a summary task the smallest float of its subtasks.

Read-only.

None

Declared by WklGantt.

Property Get IsCritical(ByVal Key As Variant) As Boolean

Returns whether a task is on the critical path.

Property value: Boolean – True for a critical task, and for a summary task with a critical subtask.

Read-only.

None

Declared by WklGantt.

Property Get TaskPredecessors(ByVal Key As Variant) As String

Returns the predecessors of a task as text.

Property value: String – The short form, for example 3EA+2;5AA.

Read-only.

None

Declared by WklGantt.

Property Get TaskResources(ByVal Key As Variant) As String
Property Let TaskResources(ByVal Key As Variant, RHS As String)

Gets or sets the resources of a task as text.

Property value: String – The short form, for example Miller;Smith[50%]; an empty text removes every assignment.

Setting it replaces the assignments of the task where the chart keeps them: in the resource text (ResourcesField) or in the assignment table (AssignmentSource), where a resource is found by name and a new name is added to ResourceSource. Without either setting it raises wkeNotConfigured. Units in brackets are percent; without them a resource works 100 %. Raises no events, as other changes by code.

Read/write.

None

Declared by WklGantt.

Sub SetTaskDates(ByVal Key As Variant, ByVal Start As Date, ByVal Finish As Date)

Sets the start and finish of a task and writes them.

In automatic mode the task gets “start no earlier than” its new start, and the dependent tasks are scheduled; all changes are written in one transaction, together with the summary tasks.

None

Declared by WklGantt.

Sub LinkTasks(ByVal Predecessor As Variant, ByVal Successor As Variant, Optional ByVal LinkType As WklGanttLinkType = wglFinishToStart, Optional ByVal Lag As Double = 0)

Adds a dependency between two tasks and writes it.

A dependency that would close a cycle raises wkeCycle and writes nothing; one on a task's own summary task, a duplicate or a self link raises wkeInvalidValue. In automatic mode the successor is scheduled.

None

Declared by WklGantt.

Sub UnlinkTasks(ByVal Predecessor As Variant, ByVal Successor As Variant)

Removes the dependency between two tasks and writes that.

Raises wkeKeyNotFound when the two tasks are not linked. The successor is not moved.

None

Declared by WklGantt.

Sub SplitTask(ByVal Key As Variant, ByVal At As Date, Optional ByVal Gap As Double = 1)

Splits a task at a moment: the work after it resumes later.

Needs SegmentSource and its fields (wkeNotConfigured otherwise). The duration stays; the finish moves by the gap.

None

Declared by WklGantt.

Sub Reschedule()

Schedules every task with dependencies or constraints as soon as possible and writes the result.

None

Raises wkeCycle when the dependencies contain a cycle.

None

Declared by WklGantt.

Property Get Issues() As Variant

Returns the problems found in the data.

None

Property value: Variant – An array of texts: unknown predecessors or resources, self links, links between a summary task and its own subtasks, duplicates, cycles, unreadable texts, invalid segments, a finish before the start. Empty when the data is consistent.

Read-only.

None

Declared by WklGantt.

Property Get Violations() As Variant

Returns the rules tasks do not keep.

None

Property value: Variant – An array of texts: dependencies whose successor lies too early, constraints not kept, deadlines passed. Empty when the plan is consistent.

Read-only.

None

Declared by WklGantt.

Property Get ProjectStart() As Variant

Returns the earliest start of all tasks.

None

Property value: Variant – A date, or Null without tasks.

Read-only.

None

Declared by WklGantt.

Property Get ProjectFinish() As Variant

Returns the latest finish of all tasks.

None

Property value: Variant – A date as the table stores it, or Null without tasks.

Read-only.

None

Declared by WklGantt.

Property Get TaskKind(ByVal Key As Variant) As WklGanttTaskKind

Returns what the row of a task shows.

Property value: `WklGanttTaskKind` – A `WklGanttTaskKind` constant.

Read-only.

None

Declared by WklGantt.

Sub ExportToImage(ByVal Path As String, Optional ByVal Range As WklGanttExportRange = wgrProject, Optional ByVal AutoStart As Boolean = False)

Exports the chart, task list and timeline, as a picture.

The picture shows all records the list shows (expanded nodes, filter) and all its columns, at the screen size of 96 dpi. wgrProject covers ChartStart to ChartFinish, or the first start to the last finish, with a margin as in the form; wgrVisible covers the period the timeline of the open form shows. A picture larger than 60 million pixels is refused with wkeInvalidValue; choose a coarser Zoom, a shorter period or ExportToPdf. An unknown extension raises wkeInvalidValue.

None

Declared by WklGantt.

Sub ExportToPdf(ByVal Path As String, Optional ByVal Range As WklGanttExportRange = wgrProject, Optional ByVal AutoStart As Boolean = False)

Exports the chart as a PDF document on A4 pages in landscape.

The chart is drawn up to twice the screen resolution and made smaller, down to half the screen size, until its width fits the page. A wider chart continues on further pages to the right, with the task list repeated when it takes at most half a page. Pages go down first, then across; every page repeats the header, and each page has a footer with the control's name, the page number and the date. The text is part of the picture: it prints sharply but cannot be searched or copied. The period follows Range as in ExportToImage.

None

Declared by WklGantt.

Sub ExportToProject(ByVal Path As String, Optional ByVal AutoStart As Boolean = False)

Exports the plan as Microsoft Project XML, a file Microsoft Project opens.

The file contains all tasks in the order of the list, also collapsed and filtered ones, with outline, start, finish, duration, progress, milestones, constraints, deadlines and baselines; the dependencies with type and lag; the calendar with its working days, working hours and free days; and the resources with their assignments. When every key is a whole number from 1 to 2 147 483 647 (a Long or AutoNumber key field), the key becomes the task's unique ID in Project, so a later import finds the records again; otherwise the tasks are numbered in order.

When ProjectUidField is set, a UID stored there wins, and tasks without one get new UIDs above the highest.

Project schedules every task of the file automatically. To keep the dates of the chart, a task without constraint is written with “Start No Earlier Than” its own start; a task that breaks a dependency in wgsManual moves in Project. Split tasks are written from their first to their last part, and the look of the chart (colors, bar styles) is not part of the XML format. The file follows the Project 2007 XML schema, which later versions of Project read as well.

With Me!Gantt1.Object
    .ExportToXlsx "Plan.xlsx", wemWysiwyg
    .ExportToPdf "Plan.pdf", wgrProject, True
    .ExportToProject "Plan.xml"
End With

Declared by WklGantt.

Property Get ProjectUidField() As String
Property Let ProjectUidField(RHS As String)

Gets or sets the field that holds the unique ID (UID) of each task in Microsoft Project.

None

Property value: String – The field name; empty (default) when the key is the UID.

A number field (Long). ImportFromProject fills it for every task it writes and, with wgiAuto or wgiUidField, finds the records by it; ExportToProject writes the stored UID back. Set it before the first import of a plan made in Project: the records then keep the UIDs of the file, whatever keys the table gives them.

Read/write.

None

Declared by WklGantt.

Function ImportFromProject(ByVal Path As String, Optional ByVal MatchBy As WklGanttImportMatch = wgiAuto, Optional ByVal DeleteMissing As Boolean = False, Optional ByVal ShowDialog As Boolean = False) As Long

Reads a Microsoft Project XML file and writes its tasks, dependencies and resource assignments into the tables, by matching.

Return value: Long

A task of the file that finds its record (see WklGanttImportMatch) writes its name, start, finish (or duration), progress, milestone, constraint, deadline and baseline into the mapped fields and moves to its summary task (ParentField), where these differ; a task without record is added. Summary tasks write their name only, because their dates and progress follow their subtasks. Dependencies of the file are added or rewritten in DependencySource or the predecessor text; resource assignments in the resource text or in AssignmentSource, where a resource of the file is found by name or added to ResourceSource. Free days of the file's calendar are added to HolidaySource. Working days and hours are properties of the form and are not imported; the dialog says when they differ.

Without DeleteMissing nothing is deleted: records the file does not have stay, and so do dependencies and assignments the file does not name. Everything is written in one transaction; an error writes nothing and raises the error. By code the import raises no BeforeUpdate/AfterUpdate; from the dialog every record raises them as an edit of the user.

A new record gets its key from the database (AutoNumber) or, for a number key, the UID of the task when it is free, otherwise the next free number; then importing the same file again finds the record even without ProjectUidField. New records need a key of one field; with a composite key assign every task to a record in the dialog.

The dialog lists every task with its status (new, change, same), its dates and the changed fields, and the records the file does not have. Choose another rule for the whole file, another record for a task (a record belongs to one task), clear “Take over” for tasks to leave out, and check “Delete tasks missing in the file” to delete the listed records.

With Me!Gantt1.Object
    .ProjectUidField = "ProjektUID"
    ' First import of a plan made in Project: by name, check it in the dialog.
    .ImportFromProject "Umzug.xml", wgiName, False, True
    ' Later imports of the same file find their records by the stored UID.
    Debug.Print .ImportFromProject("Move.xml") & " tasks changed"
End With

Declared by WklGantt.

Sub IndentTask(ByVal Key As Variant)

Indents a task: it becomes the last subtask of the task before it on its level.

Writes ParentField, as Alt+Shift+Right and Indent in the shortcut menu do (they raise NodeDrop, AfterNodeDrop and BeforeUpdate/AfterUpdate; by code none). The task before it becomes a summary task; with UpdateSummaries its computed dates are written. A task without a task before it on its level raises wkeInvalidValue.

None

Declared by WklGantt.

Sub OutdentTask(ByVal Key As Variant)

Outdents a task: it follows its summary task on the summary's level.

Moves the task with its own subtasks; the tasks after it stay under the summary task (unlike Microsoft Project, which would move them along, because records the user did not select are not changed). A task on the top level raises wkeInvalidValue.

None

Declared by WklGantt.

Event BeforeTaskChange(ByVal Key As Variant, ByRef Start As Variant, ByRef Finish As Variant, ByRef Progress As Variant, ByRef Cancel As Integer)

Occurs before the user changes a task by dragging, in the grid or by the progress handle.

In a form module: Private Sub <ControlName>_BeforeTaskChange(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklGantt.

Event AfterTaskChange(ByVal Key As Variant)

Occurs after the user changed a task and it was written.

In a form module: Private Sub <ControlName>_AfterTaskChange(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklGantt.

Event BeforeLinkAdd(ByVal Predecessor As Variant, ByVal Successor As Variant, ByRef LinkType As Long, ByRef Lag As Double, ByRef Cancel As Integer)

Occurs before the user adds a dependency.

In a form module: Private Sub <ControlName>_BeforeLinkAdd(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklGantt.

Event AfterLinkAdd(ByVal Predecessor As Variant, ByVal Successor As Variant)

Occurs after the user added a dependency and it was written.

In a form module: Private Sub <ControlName>_AfterLinkAdd(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklGantt.

Event BeforeLinkDelete(ByVal Predecessor As Variant, ByVal Successor As Variant, ByRef Cancel As Integer)

Occurs before the user deletes a dependency.

In a form module: Private Sub <ControlName>_BeforeLinkDelete(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklGantt.

Event AfterLinkDelete(ByVal Predecessor As Variant, ByVal Successor As Variant)

Occurs after the user deleted a dependency.

In a form module: Private Sub <ControlName>_AfterLinkDelete(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklGantt.

Event TaskClick(ByVal Key As Variant)

Occurs when the user clicks a bar.

In a form module: Private Sub <ControlName>_TaskClick(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklGantt.

Event TaskDblClick(ByVal Key As Variant)

Occurs when the user double-clicks a bar.

In a form module: Private Sub <ControlName>_TaskDblClick(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklGantt.