ScPro.ocx 3.0.0 developer’s guide

The Scheduler Pro Control object routines are divided in 5 main categories:

Category | Description
Calendar | Calendar and non-work period (properties, methods, events)
Gantt | Gantt, panel and overall management (properties, methods, events)
Resources | Resources (properties, methods, events)
Time Blocks | Time block, style bars and links (properties, methods, events)
Scheduler | Scheduler only in Pro Edition (properties, methods, events)

Calendar routines overview

Index

The following routines are used for the Calendar (and Non-work) management in the Scheduler Pro Control object.

Properties | Methods | Events
CalBackColor | CalRefresh | CalClick
CalFont | NwAdd | CalDblClick
CalForeColor | NwClear | NwClick
CalStyle |  | NwDblClick
NwBeg |  |
NwMax |  |
NwRes |  |
NwType |  |
NwUser |  |
NwBackColor |  |
NwMode |  |

CalBackColor Property

Sets or returns the default backcolor of the Calendar.

Syntax

ScProOCX.CalBackcolor [ = value ]

The CalBackcolor property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
value | An ole color expression of the background color

Remarks

The default backcolor is &H00800000& (blue).

See Also

CalForeColor property

CalFont Property

Sets or returns the default calendar font.

Syntax

ScProOCX.CalFont.Prop [ = value ]

The CalFont property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
Prop | Allowed properties: Name, Size, Bold, Italic, Underline, Strikethrough
value | A font expression containing the default resource font parameters

Remarks

The default font is Arial Narrow bold 8.

See Also

CalStyle property

CalForeColor Property

Sets or returns the default forecolor of the Calendar.

Syntax

ScProOCX.CalForecolor [ = value ]

The CalForecolor property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
value | An ole color expression of the foreground color

Remarks

The default forecolor is &HFFFFFF& (white).

See Also

CalBackColor property

CalStyle Property

Sets or returns the default calendar style.

Syntax

ScProOCX.CalStyle [ = action ]

The CalStyle property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
action | An integer expression that sets the calendar style. The action value is set by adding the below numbers to get the desired behaviour.

Settings

Possible settings for action are:

action | Description
0 | Month style (Month, day, hour)
1 | Week style (Week, weekday, hour)

Remarks

The default calendar style is 0.

To force the display refresh use the CalRefresh method.

See Also

CalRefresh method

NwBeg Property

Returns the beginning date of an existing non-work period (read only property).

Syntax

ScProOCX.NwBeg (index As Integer)

The NwBeg property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
index | A numeric expression of the index of an existing non-work period.

Remarks

The beginning date is assigned when adding a non-work period (see NwAdd method).

See Also

NwAdd method

NwDur Property

Returns the duration (in hours) of an existing non-work period (read only property).

Syntax

ScProOCX.NwDur (index As Integer)

The NwDur property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
index | A numeric expression of the index of an existing non-work period.

Remarks

The duration is assigned when adding a non-work period (see NwAdd method).

See Also

NwAdd method

NwMax Property

Returns the upper bound of the non-work array (read only property).

Syntax

ScProOCX.NwMax

The NwMax property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.

Remarks

The lower bound of the non-work array is 1. If the lower/upper bound is 0, the array is empty.

See Also

NwAdd method

NwRes Property

Returns the resource user ID of an existing non-work period (read only property)

Syntax

ScProOCX.NwRes (index As Integer)

The NwRes property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
index | A numeric expression of the index of an existing non-work period.

Remarks

The resource user ID is assigned when adding a non-work period (see NwAdd method).

See Also

NwAdd method

NwType Property

Returns the type of an existing non-work period (read only property)

Syntax

ScProOCX.NwType (index As Integer)

The NwType property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
index | A numeric expression of the index of an existing non-work period.

Remarks

The type is assigned when adding a non-work period (see NwAdd method).

See Also

NwAdd method

NwUser Property

Returns the user description of an existing non-work period (read only property)

Syntax

ScProOCX.NwUser (index As Integer)

The NwUser property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
index | A numeric expression of the index of an existing non-work period.

Remarks

The user description is assigned when adding a non-work period (see NwAdd method).

See Also

NwAdd method

NwBackColor Property

Sets or returns the default backcolor of the non-work period.

Syntax

ScProOCX.NwBackcolor [ = value ]

The NwBackcolor property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
value | An ole color expression of the background color

Remarks

The default backcolor is &H008080FF& (pink).

See Also

NwAdd method

NwMode Property

Sets or returns how nonwork blocks are displayed .

Syntax

ScProOCX.NwMode [ = action ]

The NwMode property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
action | An integer expression that sets how non work periodss are displayed. The action value is set by adding the below numbers to get the desired behaviour.

Settings

Possible settings for action are:

action | Description
0 | Display non work as objects
1 | Display non work as background color (no events e no tooltip on non work period)

Remarks

The default action is 0. For action 1 no events are fired in the non work period, but displaying of gantt projects is much faster (>100x!): if you use a lot of non work periods you shoud use this option .

Remember that it is not possible to change the action if any non work period is loaded!

Before loading or adding a great number of non work periods you should set the control container visible property to false (after loading set the visible property to true) in order to achieve a better performance.

See Also

NwAdd method

CalRefresh Method

This method updates the calendar with the specified style and forces a display refresh in the Scheduler Pro Control object.

Syntax

ScProOCX.CalRefresh (MyStyle As Integer)

The CalRefresh method has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
MyStyle | An integer expression for the calendar style

Returns

= 1 - Refresh was successful

= 0 - Refresh failed (an error occurred while refreshing the calstyle)

Remarks

For the MyStyles values refer to the CalStyle property.

See Also

CalStyle

NwAdd Method

This method loads the specified non work period in the Scheduler Pro Control object.

Syntax

ScProOCX.NwAdd (NWres As Integer, NWbeg As Date, NWdur As Single, NWtype As Integer, NWuser As String)

The NwAdd method has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
NWres | A numeric expression for the resource user ID
NWbeg | A date expression of the non work start
NWdur | A single expression for the non work duration (in hours)
NWtype | An integer expression for non work type specification (0,1)
NWuser | A string expression for the non work description

Returns

> 0 - Add was successful (returns the non-work index)

= 0 - Add failed (an error occurred while adding this non-work period)

Remarks

If the GanttMode> 0 you have to reload/refresh the time blocks in order to consider the new calendar.

Before loading or adding a great number of non work periods you should set the control container visible property to false (after loading set the visible property to true) in order to achieve a better performance.

See Also

NwClear method, GattMode property

NwClear Method

This method deletes the specified existing non-work periods in the Scheduler Pro Control object .

Syntax

ScProOCX.NwClear ([Index As Integer ])

The NwClear method has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
Index | A numeric expression for the index of the non-work array .

Returns

> 0 - Clear was successful (returns the deleted non-work index)

= 0 - Clear failed (an error occurred while deleting this non-work period)

Remarks

If Index=0 (or not specified) then all the existing non-work periods are deleted.

See Also

NwAdd method

CalClick Event

Fires when a mouse click occurs on the calendar.

Syntax (Visual Basic)

Private Sub ScProOCX1_CalClick (curdate as date, button as integer )

The CalClick event has these parts:

Part | Description
curdate | A date expression containing the date calculated in the click point
button | A numeric expression for the mouse button (1 left, 2 right)

Remarks

The sequence of ScPro Control is

· CalClick

· CalDblClick

See Also

CalDblClick

CalDblClick Event

Fires when a mouse double click occurs on the calendar.

Syntax (Visual Basic)

Private Sub ScProOCX1_CalDblClick(curdate as integer)

The CalDblClick event has these parts:

Part | Description
curdate | A date expression containing the date calculated in the double click point

Remarks

The sequence of ScPro Control is

· CalClick

· CalDblClick

See Also

CalClick

NwClick Event

Fires when a mouse click occurs on the non-work period.

Syntax (Visual Basic)

Private Sub ScProOCX1_NwClick(index as integer, button as integer)

The NwClick event has these parts:

Part | Description
index | An integer expression containing the non-work period index
button | A numeric expression for the mouse button (1 left, 2 right)

Remarks

The sequence of ScPro Control is

· NwClick

· NwDblClick

See Also

NwDblClick

NwDblClick Event

Fires when a mouse double click occurs on the non-work period.

Syntax (Visual Basic)

Private Sub ScProOCX1_NwDblClick(index as integer)

The NwDblClick event has these parts:

Part | Description
index | An integer expression containing the non-work period index

Remarks

The sequence of ScPro Control is

· NwClick

· NwDblClick

See Also

NwClick

Gantt routines overview

Index

The following routines are used for the Gantt management in the Scheduler Pro Control object.

Properties | Methods | Events
GanttBackcolor | GanttClear | GanttClick
GanttDropMode | GanttPan | GanttDblClick
GanttIni | GanttPrint | GanttOpenClick
GanttLock | GanttOpen | GanttSaveClick
GanttMode | GanttSave |
GanttPanel | GanttPrintMulti |
GanttTimeLine | GanttPrintHtml |
GanttWin | GanttReg |
GanttZoom |  |
GanttResIndex |  |
GanttDayLine |  |
GanttDayLineColor |  |
GanttLink |  |
GanttFrameStart |  |
GanttFrameEnd |  |
GanttScrollMode |  |
GanttBalance |  |
GanttMulti |  |
GanttDesc |  |
GanttOcxBackColor |  |
GanttToolTip |  |
GanttDropIN |  |
GanttNoSymbol |  |

GanttBackColor Property

Sets or returns the backcolor of the Gantt area.

Syntax

ScProOCX.GanttBackcolor [ = value ]

The GanttBackcolor property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
value | A numeric expression of the background color

Remarks

The default backcolor is &H00FFFFC0& (light blue).

See Also

GanttPrint method

GanttDropMode Property

Sets or returns how to carry out the drop action on a resource (manual or automatic) .

Syntax

ScProOCX.GanttDropMode [ = action ]

The GanttDropMode property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
action | An integer expression that sets how to drop a time block on a resource of the control. The action value is set by adding the below numbers to get the desired behaviour.

Settings

Possible settings for action are:

action | Description
0 | Ignore resource group ID
1 | Consider resource group ID

Remarks

The default action is 1.

This property is considered by the drag&drop manual action and by the TbMove method.

If the property is changed after moving the time blocks, you must reload the time blocks to consider the effect of the property.

See Also

TbMove method

GanttIni Property

Sets or returns the starting date of the gantt.

Syntax

ScProOCX.GanttIni [ = value ]

The GanttIni property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
value | A date expression of the gantt starting date

Remarks

The default starting date is the current date.

To set the gantt time interval (number of days to consider) use the GanttWin property.

See Also

GanttWin property

GanttLock Property

Sets or returns the manual drag&drop enabling.

Syntax

ScProOCX.GanttLock [ = action ]

The GanttLock property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
action | An integer expression that sets how manual drag/drop behaves

Settings

Possible settings for action are:

action | Description
0 | Enable manual drag&drop
1 | Disable manual drag&drop (default)

Remarks

The default value is 1 (drag&drop disabled).

See Also

GanttDropMode property

GanttMode Property

Sets or returns how all time blocks interact .

Syntax

ScProOCX.GanttMode [ = action ]

The GanttMode property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
action | An integer expression that sets how time blocks interact on the control. The action value is set by adding the below numbers to get the desired behaviour.

Settings

Possible settings for action are:

action | Description
0 | Ignore block overlapping and non-work periods
1 | Consider non-work periods and ignore block overlapping
2 | Consider block overlapping and ignore non-work periods
3 | Consider block overlapping and non-work periods (default)

Remarks

The default action is 3. For action>0 the time block cannot be placed before the TbAva date .

For action 0 and 1 GanttPrimaryDur and GanttSecondaryDur are ignored.

If the property is changed after adding the time blocks, you must reload the time blocks to consider the effect of the property.

See Also

TbAdd method

GanttPanel Property

Sets or returns the buttons panel.

Syntax

ScProOCX.GanttPanel [ = action ]

The GanttPanel property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
action | An integer expression that set how the panel is displayed. The action value is set by adding the below numbers.

Settings

Possible settings for action are:

action | Description
0 | Panel invisible
1 | Buttons (open, save, lock, clear) disabled, (zoom in, zoom out, print) enabled
2 | Panel enabled and visible (default)

Remarks

The default value is 2 (Panel enabled and visible).

The buttons open and save generate a click event.

See Also

GanttOpenClick event, GanntSaveClick event

GanttTimeLine Property

Sets or returns the TimeLine behaviour.

Syntax

ScProOCX.GanttTimeLine [ = action ]

The GanttTimeLine property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
action | An integer expression that set the TimeLine behavior. The action value is set by adding the below numbers

Settings

Possible settings for action are:

action | Description
0 | Time block allocation is possible before current TimLine (used to modify/view old schedules)
1 | Time block allocation in not possible before current TimeLine (used to build a new schedule: default)

Remarks

The default value is 1 (No allocation before TimeLine).

See Also

TbAllocate method, TbMove method

GanttWin Property

Sets or returns the gantt time interval (number of days to consider).

Syntax

ScProOCX.GanttWin [ = value ]

The GanttWin property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
value | An integer expression of the gantt time interval in days

Remarks

The default time interval is 30 days.

Do not exceed with the time interval value: the greater is the interval, the slower the ActiveX behaves and the zoom in function may also be limited if you don’t set the GanttScrollMode properly.

To set the gantt start date (number of days to consider) use the GanttIni property.

See Also

GanttIni property

GanttZoom Property

Sets or returns the current zoom.

Syntax

ScProOCX.GanttZoom [ = action ]

The GanttZoom property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
action | An integer expression of the current zoom. The action value is set by adding the below numbers

Settings

Possible settings for action are:

action | Description
<0 | Zoom out in (time grid step: every 8 hour (-1), every 12 hours (-2), every 24 hours (if <-2))
0 | Default (time grid step: every 4 hour)
>0 | Zoom in (time grid step: every 2 hour (1), every hour (if >1))

Remarks

The default value is 0.

See Also

GanttPan method

GanttToolTip Property

Sets or returns the current ToolTip mode.

Syntax

ScProOCX.GanttToolTip [ = action ]

The GanttToolTip property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
action | An integer expression of the tooltip mode. The action value is set by adding the below numbers

Settings

Possible settings for action are:

action | Description
0 | The time block tooltip is displayed without parameters
1 | The time block tooltip is displayed with the specified parameters (default)

Remarks

The default value is 1.

The tooltip parameters can be set with the ToolTip properties

When the property is set to 1 to display the tooltip you must press the “z” key; to hide the tooltip you can either move the cursor to another block, or click on the gantt background or double click on it; you can also copy the content of the tooltip (select text, click with mouse right button and copy)

See Also

ToolTip properties

GanttResIndex Property

Returns the resource array current index..

Syntax

ScProOCX.GanttResIndex

The GanttResIndex property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.

Remarks

Do not confuse the resource index with the resource user ID: the resorce index is the current array index (it may change after deleting ar adding resources), the resourse ID is assigned by the user when creating the resource (it cannot be changed and it must be a unique number).

See Also

ResID property

GanttDayLine Property

Sets or returns the current DayLine drawing mode.

Syntax

ScProOCX.GanttDayLine [ = action ]

The GanttDayLine property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
action | An integer expression of the day line mode. The action value is set by adding the below numbers

Settings

Possible settings for action are:

action | Description
0 | The day lines are not displayed
1 | The day lines are displayed using the current color (GanttDayLineColor)

Remarks

The default value is 0.

See Also

GanttDayLineColor property

GanttDayLineColor Property

Sets or returns the color of the DayLine.

Syntax

ScProOCX.GanttDayLineColor [ = value ]

The GanttDayLineColor property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
value | A numeric expression of the color

Remarks

The default backcolor is &H00000000& (black).

See Also

GanttDayLine property

GanttLink Property

Sets or returns how the block links are displayed.

Syntax

ScProOCX.GanttLink [ = action ]

The GanttLink property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
action | An integer expression that block links are displayed. The action value is set by adding the below numbers to get the desired behaviour.

Settings

Possible settings for action are:

action | Description
0 | Hide displayed links after the following actions: zoom, block move, block delete
1 | Arrange automatically the displayed links after the following actions: zoom, block move, block delete

Remarks

The default action is 0

See Also

LinkAdd method

GanttFrameStart Property

Returns the visible gantt start date .

Syntax

ScProOCX.GanttFrameStart [ = value ]

The GanttFrameStart property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
value | A date expression of the visible gantt window start date

Remarks

Do not confuse this property with the GanttIni: GanttFrameStart returns the visible gantt start date, GanttIni returns/sets the gantt overall start date (it may be invisible in the displayed gantt).

See Also

GanttIni property, GanttFrameEnd property

GanttFrameEnd Property

Returns the visible gantt end date .

Syntax

ScProOCX.GanttFrameEnd [ = value ]

The GanttFrameEnd property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
value | A date expression of the visible gantt window end date

Remarks

Do not confuse this property with the overall gantt end date: GanttFrameEnd returns the visible gantt end date, the overall gantt end date may be calculated with the GanttIni and GanttWin properties.

See Also

GanttIni property, GanttFrameStart

GanttScrollMode Property

Sets the horizontal gantt scroll behavior.

Syntax

ScProOCX.GanttScrollMode [ = action ]

The GanttScrollMode property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
action | An integer expression that sets the gantt scroll mode. The action value is set by adding the below numbers to get the desired behaviour.

Settings

Possible settings for action are:

action | Description
0 | The scroll arrows scroll the gantt with a default step (resourse width), the scroll box scrolls the gantt continuously (50 twips step): zooming and scrolling are possible only in one gantt page (default maximun page size is 245745 twips: to decrease the page size modify and use the registry file frame.reg; do not use pages bigger then 245745 twips)
1 | The scroll arrows scroll the gantt with a default step (resourse width) and when they reach the start/end of the current page they load the previous/next gantt page (if available), the scroll box scrolls the gantt continuously (50 twips): zooming and scrolling are possible without limits using a proper quantity of gantt pages (automatic)
2 | The scroll arrows load the previous/next gantt page (if available), to scroll the current page drag the scroll box: zooming and scrolling are possible without limits using a proper quantity of gantt pages (automatic)

Remarks

The default scroll mode is 0 (only one gantt page): if you are plannig to use a gantt time interval longer then 60 days, you should use the multi page mode (1 or 2) in order to be able to zoom in without incurring in page limits on far away days.

See Also

GanttWin property

GanttBalance Property

Sets or returns how time blocks are balanced on resources of the same group (available only in Pro Edition) .

Syntax

ScProOCX.GanttBalance [ = action ]

The GanttBalance property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
action | An integer expression that sets how time blocks are balanced on resources of the same group. The action value is set by adding the below numbers to get the desired behaviour.

Settings

Possible settings for action are:

action | Description
0 | Do not balance the time blocks (default)
1 | Balance the time blocks
2 | Balance the time blocks and keep together blocks with the same description

Remarks

The default action is 0. Locked time blocks are ignored.

This property is considered only by the SchRun method.

If action is set to 2, blocks with the same description are kept together if they have the same scheduling weight.

See Also

SchRun method

GanttMulti Property

Sets or returns the multi resource time block management (design and run time property) .

Syntax

ScProOCX.GanttMulti [ = action ]

The GanttMulti property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
action | An integer expression that sets how multi resource time blocks are handled. The action value is set by adding the below numbers to get the desired behaviour.

Settings

Possible settings for action are:

action | Description
0 | Ignore the multi resource time blocks (default)
1 | Handle the multi resource time blocks (valid for blocks with the same TbGroup negative value)

Remarks

The default action is 0. This property is available at design and run time

This property is considered only for time blocks where the TbGroup property has a negative value.

Remember that each time lock of the multi group must have the same unique negative TbGroup and that you cannot add more than 1 time block per resource (for each multi group).

TbAdd, TbMove, drag&drop can be used with a multi group time block; do not use TbAllocate with a multi group time block (it will violate your Multi block alignment)

See Also

TbAdd method

GanttDesc Property

Sets or returns the gantt panel title (ScPro).

Syntax

ScProOCX.GanttDesc [ = value ]

The GanttDesc property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
value | A string expression of the gantt panel title

Remarks

The default value is ScPro.

See Also

GanttPanel property

GanttOcxBackColor Property

Sets or returns the backcolor of the Ocx area (the container of the Gantt area).

Syntax

ScProOCX.GanttOcxBackcolor [ = value ]

The GanttOcxBackcolor property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
value | A numeric expression of the background color

Remarks

Do not confuse this property with the GanttBackColor.

See Also

GanttPrint method

GanttDropIn Property

Sets or returns the time block drop behavior (design and run time property) .

Syntax

ScProOCX.GanttDropIn [ = action ]

The GanttDropIn property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
action | An integer expression that sets how the drop action is handled. The action value is set by adding the below numbers to get the desired behaviour.

Settings

Possible settings for action are:

action | Description
0 | Do not allow the drop of a time block over another time block (default)
1 | Allow dropping of a time block over another and move if forward to the the end of the undelaying block

Remarks

The default action is 0. This property is available at design and run time

This property is considered only for time blocks when GanttMode>0.

See Also

GanttMode property

GanttNoSymbol Property

Sets or returns the time block appearance (design and run time property) .

Syntax

ScProOCX.GanttNoSymbol [ = action ]

The GanttNoSymbol property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
action | An integer expression that sets how the time blocks appearance is handled. The action value is set by adding the below numbers to get the desired behaviour.

Settings

Possible settings for action are:

action | Description
0 | Show the time block start symbol (default)
1 | Hide the time block start symbol: the performance of the ocx is much faster (even if the time block has no start symbol)

Remarks

The default action is 0. This property is available at design and run time.

Do not change this property after loading time blocks: changes can be achieved only before loading time blocks.

Methods such as TbAdd or GanttPan are much faster if you set this property to 1.

See Also

BarAdd method

GanttClear Method

This method clears all the elements added to the Gantt (it is a complete reset of the arrays) in the Scheduler Pro Control object.

Syntax

ScProOCX.GanttClear

The GanttClear method has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.

Returns

> 0 - Clear was successful

= 0 - Clear failed (an error occurred while adding this block)

Remarks

This method resets the time block array, the non-work array the resources array and the style bar array.

See Also

BarAdd method, ResAdd method, NwAdd method, TbAdd method

GanttPan Method

This method applies a zoom in the specified starting date in the Scheduler Pro Control object.

Syntax

ScProOCX.GanttPan (myzoom As Integer [, myDate As date ])

The GanttPan method has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
myzoom | +1 for zooming in, -1 for zooming out , 0 for refreshing zoom
mydate | A date expression of the stating zoom point

Returns

> 0 - Zoom was successful

= 0 - Zoom failed (an error occurred while zooming)

Remarks

This method zooms in/out the time blocks of the gantt area and the calendar area dinamically: the GanttIni property sets the start point of the Gantt (initial date of the gantt/calendar area), the GanttWin property sets the end point of the Gantt (period in days from the initial date).

To zoom in use +1, to zoom out use -1: 0 will refresh the time blocks and the calendar area leaving the current zoom.

The specified date will be the left starting point of the zoomed new window: if no date is specified, will be considered the current left starting point.

If you incur in error 480 (“Can't AutoRedraw image”) or error 7 (“Out of memory”) you can reduce the page size (default: 245745 twips, it can be reduced using the attached registry file frame.reg), or eventually set the GanttNoSymbol property to 1, or reduce the resource height.

See Also

GanttIni property, GanttWin property

GanttPrint Method

This method prints the window containing the Scheduler Pro Control object (without the scroll bars).

Syntax

ScProOCX.GanttPrint

The GanttPrint method has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.

Returns

> 0 - Print was successful

= 0 - Print failed (an error occurred while printing)

Remarks

This method prints the displayed ScPro object: before printing it is possible to resize (manually or using the GanttPan method) the window in order to select the area to be printed .

The default printer orientation is vertical, but if the window width is greater than the printer width then the horizontal printer orientation will be automatically selected.

See Also

GanttPan

GanttOpen Method

This method load a previously saved gantt project in the Scheduler Pro Control object.

Syntax

ScProOCX.GanttOpen (mypath As string)

The TbPan method has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
mypath | The complete path of the file to be loaded

Returns

> 0 - Open was successful

= 0 - Open failed (an error occurred while opening the file)

Remarks

This method loads all the object of the saved project (gantt defaults, resources, style bars, non work periods, time blocks,links) and sets the GanttTimeLine property to 0 (in order to deal with past time blocks).

See Also

GanttSave

GanttSave Method

This method saves the current gantt project in a specified file.

Syntax

ScProOCX.GanttSave (mypath As string)

The TbPan method has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
mypath | The complete path of the file to be saved

Returns

> 0 - Save was successful

= 0 - Save failed (an error occurred while opening the file)

Remarks

This method saves all the objects of the current project (gantt defaults, resources, style bars, non work periods, time blocks, links) in a specified file.

See Also

GanttOpen

GanttPrintMulti Method

This method prints the specified gantt window (horizontal scrolling is automatic).

Syntax

ScProOCX.GanttPrintMulti (StartDate As date , EndDate As date)

The GanttPrintMulti method has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
StartDate | Start date of the print window
EndDate | End date of the print window

Returns

> 0 - Print was successful

= 0 - Print failed (an error occurred while printing)

Remarks

This method prints only the displayed resources (vertical scrolling is not provided).

The default printer orientation is vertical, but if the window width is greater than the printer width then the horizontal printer orientation will be automatically selected.

See Also

GanttPrint

GanttPrintHtml Method

This method prints the specified gantt information (provided on a list base) in the specified Html file.

Syntax

ScProOCX.GanttPrintHtml (Path As string, Title As string, StartDate As date , EndDate As date [, IDres as integer ] [, BlockType as integer ])

The GanttPrintHtml method has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
Path | Complete path of the html file
Title | Title to be inserted in the html file
StartDate | Start date of the gantt information
EndDate | End date of the gantt information
IDres | ID of the resource: if not specified all the resources will be considered
BlockType | Type of information to be inserted in the html file (1 NonWork, 2 TimeBlock, 3 All): if not specified all the information will be considered (default 3)

Returns

> 0 - Print was successful

= 0 - Print failed (an error occurred while printing)

Remarks

To display the printed html file just invoke your favourite browser stating the html file path.

See Also

GanttPrintMulti

GanttReg Method

This method enables registering at run time.

Syntax

ScProOCX.GanttReg (value as string)

The GanttReg method has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
Value | A string expression containing the customer licence key

Returns

> 0 - Register was successful

= 0 - Register failed (an error occurred)

Remarks

This method is useful in application distribution.

See Also

BarAdd method, ResAdd method, NwAdd method, TbAdd method

GanttClick Event

Fires when a mouse click occurs on the gantt background.

Syntax (Visual Basic)

Private Sub ScProOCX1_GanttClick(curdate as date, button as integer)

The GanttClick event has these parts:

Part | Description
curdate | A date expression containing the date calculated in the click point
button | A numeric expression for the mouse button (1 left, 2 right)

Remarks

The sequence of ScPro Control is

· GanttClick

· GanttDblClick

See Also

GanttDblClick

GanttDblClick Event

Fires when a mouse double click occurs on the gantt background.

Syntax (Visual Basic)

Private Sub ScProOCX1_GanttDblClick(curdate as date)

The GanttDblClick event has these parts:

Part | Description
curdate | A date expression containing the date calculated in the click point

Remarks

The sequence of ScPro Control is

· GanttClick

· GanttDblClick

See Also

GanttClick

GanttOpenClick Event

Fires when a mouse click occurs on the open button of the gantt panel.

Syntax (Visual Basic)

Private Sub ScProOCX1_GanttOpenClick()

The GanttOpenClick event has these parts:

Part | Description
() | No data

Remarks

This event can be used to fire a procedure that opens a previously saved Gantt Project.

See Also

GanttSaveClick

GanttSaveClick Event

Fires when a mouse click occurs on the save button of the gantt panel.

Syntax (Visual Basic)

Private Sub ScProOCX1_GanttSaveClick()

The GanttSaveClick event has these parts:

Part | Description
() | No data

Remarks

This event can be used to fire a procedure that saves the current Gantt Project.

See Also

GanttOpenClick

Resource routines overview

Index

The following routines are used for the Resource management in the Scheduler Pro Control object.

Properties | Methods | Events
ResAlignment | ResAdd | ResClick
ResBackColor | ResClear | ResDblClick
ResDesc | ResIndex |
ResFont | ResCapacity |
ResForeColor | ResLoad |
ResGroup | ResTop |
ResHeight |  |
ResID |  |
ResKey |  |
ResMax |  |
ResWidth |  |
ResPrimaryDur |  |
ResSecondaryDur |  |
ResMode |  |
ResEff |  |
ResBackColorI |  |

ResAlignment Property

Sets or returns the default alignment of the resource text.

Syntax

ScProOCX. ResAlignment [ = action]

The ResAlignment property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
action | An integer expression that sets how align the text in the resource. The action value is set by adding the below numbers.

Settings

Possible settings for action are:

action | Description
0 | Align left (default)
1 | Align right
2 | Align center

Remarks

The default action is 0.

See Also

ResAdd method

ResBackColor Property

Sets or returns the default backcolor of the Resource.

Syntax

ScProOCX.ResBackcolor [ = value ]

The ResBackcolor property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
value | An ole color expression of the background color

Remarks

The default backcolor is &HC0& (red).

See Also

ResAdd method

ResDesc Property

Sets or returns the text description of the resource.

Syntax

ScProOCX.ResDesc (index as integer) [ = value ]

The ResDesc property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
index | A numeric expression of the resource array index
value | A string expression containing the description of the resource

Remarks

The lower bound of the resource array is 1 (if the lower or upper bound is 0, the array is empty).

To check the array upper bound use the ResMax property

See Also

ResMax property, ResAdd property

ResFont Property

Sets or returns the default resource font.

Syntax

ScProOCX.ResFont.Prop [ = value ]

The ResFont property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
Prop | Allowed properties: Name, Size, Bold, Italic, Underline, Strikethrough
value | A font expression containing the default resource font parameters

Remarks

The default font is Ms San Serif bold 10.

See Also

ResAdd property

ResForeColor Property

Sets or returns the default forecolor of the Resource.

Syntax

ScProOCX.ResForecolor [ = value ]

The ResForecolor property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
value | An ole color expression of the foreground color

Remarks

The default forecolor is &HFFFFFF& (white).

See Also

ResAdd method

ResGroup Property

Returns the user group key of the resource (read only)

Syntax

ScProOCX.ResGroup (index as integer)

The ResGroup property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
index | A numeric expression of the resource array index

Remarks

The lower bound of the resource array is 1 (if the lower or upper bound is 0, the array is empty).

To check the array upper bound use the ResMax property

See Also

ResMax property, ResAdd property

ResHeight Property

Sets or returns the default resource height.

Syntax

ScProOCX.ResHeight [ = value ]

The ResHeightproperty has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
value | A numeric expression of the requested height (twips)

Remarks

The default resource height is 450 twips.

See Also

ResAdd property

ResID Property

Returns the user numeric key of the resource (read only)

Syntax

ScProOCX.ResID (index as integer)

The ResID property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
index | A numeric expression of the resource array index

Remarks

The lower bound of the resource array is 1 (if the lower or upper bound is 0, the array is empty).

To check the array upper bound use the ResMax property

The user ID may different from the resource array index. The array index can be retrieved from the ID using the ResIndex method.

See Also

ResMax property, ResAdd property, ResIndex method

ResKey Property

Sets or returns the user string key of the resource (read only)

Syntax

ScProOCX.ResKey (index as integer) [ = value ]

The ResKey property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
index | A numeric expression of the resource array index
value | A string expression containing the user key

Remarks

The lower bound of the resource array is 1 (if the lower or upper bound is 0, the array is empty).

To check the array upper bound use the ResMax property

See Also

ResMax property, ResAdd property

ResMax Property

Returns the upper bound of the resource array (read only property).

Syntax

ScProOCX.ResMax

The TbMax property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.

Remarks

The lower bound of the resource array is 1. If the lower/upper bound is 0, the array is empty.

See Also

ResAdd method

ResWidth Property

Sets or returns the default resource width.

Syntax

ScProOCX.ResWidth [ = value ]

The ResWidth property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
value | A numeric expression of the requested width (twips)

Remarks

The default resource width is 1500 twips.

See Also

ResAdd method

ResPrimaryDur Property

Sets or returns the required duration (in hours) of a primary setup of an existing resource.

Syntax

ScProOCX.ResPrimaryDur (index As Integer) [ = value ]

The ResPrimaryDur property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
index | A numeric expression of the index of an existing resource.
value | A numeric (single) expression for the primary setup duration.

Remarks

The duration may be assigned after adding a resource (see ResAdd method).

This property is ignored on resources where GanttMode <2 and ResMode<2.

Any time block added on a resource considers an additional duration due to primary setup if the previous time block (on the same resource) has a different setup code.

See Also

ResAdd method, ResSecondaryDur property

ResSecondaryDur Property

Sets or returns the required duration (in hours) of a secondary setup of an existing resource.

Syntax

ScProOCX.ResSecondaryDur (index As Integer) [ = value ]

The ResSecondaryDur property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
index | A numeric expression of the index of an existing resource.
value | A numeric (single) expression for the primary setup duration.

Remarks

The duration may be assigned after adding a resource (see ResAdd method).

This property is ignored on resources where GanttMode <2 and ResMode<2.

Any time block added on a resource considers an additional duration due to secondary setup if the previous time block (on the same resource) has the same setup code.

See Also

ResAdd method, ResPrimaryDur property

ResMode Property

Sets or returns how the time blocks of a specific resource interact (useful to create an infinite capacity resource that has to interact with other existing finite capacity resources).

Syntax

ScProOCX.ResMode (index As Integer) [ = action ]

The ResMode property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
index | A numeric expression of the index of an existing resource.
action | An integer expression that sets how time blocks interact on the resource. The action value is set by adding the below numbers to get the desired behaviour.

Settings

Possible settings for action are:

action | Description
-1 | Behave according to GanttMode property (default)
0 | Ignore block overlapping and non-work periods
1 | Consider non-work periods and ignore block overlapping
2 | Consider block overlapping and ignore non-work periods
3 | Consider block overlapping and non-work periods

Remarks

The default action is -1: in this case is considered the GanttMode property.

For action>0 the time block cannot be placed before the TbBeg date.

For action 0 and 1 GanttPrimaryDur and GanttSecondaryDur are ignored.

If the property is changed after adding the time blocks, you must reload the time blocks to consider the effect of the property.

See Also

GanttMode property

ResEff Property

Sets or returns the efficiency (in %) of an existing resource: it decreases or increases the time block duration.

Syntax

ScProOCX.ResEff (index As Integer) [ = value ]

The ResEff property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
Index | A numeric expression of the index of an existing resource.
Value | A numeric (integer) expression for efficiency (>0).

Remarks

The efficiency of a resource must be assigned before adding time blocks.

This property may be used to consider the different performance of a resource to handle the same task (time block).

Examples:

- with efficiency set to 50 the duration of the time block will be the double (increase)

- with efficiency set to 200 the duration of the time block will be the half (decrease)

See Also

ResAdd method

ResBackColorI Property

Sets or returns the background color of an added resource.

Syntax

ScProOCX.ResBackColorI (index as integer) [ = value ]

The ResBackColorI property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
index | A numeric expression of the resource array index
value | An OLE color expression containing the background color of the resource

Remarks

The lower bound of the resource array is 1 (if the lower or upper bound is 0, the array is empty).

To check the array upper bound use the ResMax property

See Also

ResMax property, ResAdd property

ResAdd Method

This method loads the specified resource in the Scheduler Pro Control object.

Syntax

ScProOCX.ResAdd (ID As Integer, Key As String, Desc As String [, Group As String ])

The ResAdd method has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
ID | A numeric expression for the resource ID (unique index)
Key | A string expression for the user resource Key
Desc | A string expression for the resource description (displayed in the resource).
Group | A string expression for the group ID (used to specify equivalent resources)

Returns

> 0 - Add was successful (returns the resource index)

= 0 - Add failed (an error occurred while adding this resource)

Remarks

If the GanttDropMode= 1 then when using the drag&drop manual action (or the TbMove method) the group ID is verified (source and target must have the same group ID, otherwise the action is withdrown) .

The indexes of the resource array are dynamic (can vary when deleting or adding resources). It is possible to retrieve the current index of a resource with the ResIndex method. The ID must be unique.

If you have to load a lot of resources set the GanttWin property to 1 before loading the resources and afterwards set the GanttWin property to the original/required value: this increases considerably the method performance.

To avoid to incur in error 480 (“Can't AutoRedraw image”) do not exaggerate the number of resources and eventually specify a minimum suitable ResHeight.

See Also

ResIndex method, GattDropMode

ResClear Method

This method clears the specified element of the resource array in the Scheduler Pro Control object.

Syntax

ScProOCX.ResClear ([ID As Integer ])

The ResClear method has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
ID | A numeric expression for the user ID of the resource array .

Returns

> 0 - Clear was successful (returns the deleted resource ID)

= 0 - Clear failed (an error occurred while deleting this resource)

Remarks

The user ID may differ from the resource array index.

If ID=0 (or not specified) then all the existing resources are deleted.

If time blocks or non work periods are present in the gantt project, then a resource cannot be deleted.

See Also

ResAdd method, ResIndex method

ResIndex Method

This method retrieves the resource array index of a given user ID in the Scheduler Pro Control object.

Syntax

ScProOCX.ResIndex (ID As Integer)

The ResIndex method has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
ID | A numeric expression for the resource ID (unique index)

Returns

> 0 - Retrieve was successful (returns the resource array index)

= 0 - Retrieve failed (an error occurred while retrieving the array index)

Remarks

The indexes of the resource array are dynamic (can vary when deleting or adding resources).

See Also

ResAdd method

ResCapacity Method

This method returns the resource capacity in the specified time interval.

Syntax

ScProOCX.ResCapacity (Index As Integer, Istart As Date, Iend As Date)

The ResCapacity method has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
Index | A numeric expression for the resource index
Istart | A date expression of the interval start date
Iend | A date expression of the interval end date

Returns

> 0 - Capacity value (numeric expression, single)

= 0 - No capacity

Remarks

The indexes of the resource array are dynamic (can vary when deleting or adding resources). It is possible to retrieve the current index of a resource with the ResIndex method.

The capacity of the resource in the specified interval is calculated considering the nonwork periods (specified interval - nonwork duration).

To calculate the nonwork duration of a specified period, you can subtract the capacity value to the specified interval (specified interval - capacity)

See Also

ResLoad method

ResLoad Method

This method returns the resource load in the specified time interval.

Syntax

ScProOCX.ResLoad (Index As Integer, Istart As Date, Iend As Date)

The ResLoad method has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
Index | A numeric expression for the resource index
Istart | A date expression of the interval start date
Iend | A date expression of the interval end date

Returns

> 0 - Load value (numeric expression, single)

= 0 - No Load

Remarks

The indexes of the resource array are dynamic (can vary when deleting or adding resources). It is possible to retrieve the current index of a resource with the ResIndex method.

The Load of the resource is calculated considering the all the time blocks found in the specified interval.

See Also

ResCapacity method

ResTop Method

This method sets the top visible resource.

Syntax

ScProOCX.ResTop (index As Integer)

The ResTop method has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
index | A numeric expression for the resource index

Returns

> 0 - Top resource found (returns the resource index)

= 0 - Top resource not found (an error occurred while retrieving the array index)

Remarks

The indexes of the resource array are dynamic (can vary when deleting or adding resources). It is possible to retrieve the current index of a resource with the ResIndex method.

See Also

ResAdd method

ResClick Event

Fires when a mouse click occurs on the resource.

Syntax (Visual Basic)

Private Sub ScProOCX1_ResClick (index as integer, button as integer)

The ResClick event has these parts:

Part | Description
index | An integer expression containing the resource array index
button | A numeric expression for the mouse button (1 left, 2 right)

Remarks

The sequence of ScPro Control is

· ResClick

· ResDblClick

To retrieve the user ID, use the ResID property

See Also

ResDblClick , ResID property

ResDblClick Event

Fires when a mouse double click occurs on the resource.

Syntax (Visual Basic)

Private Sub ScProOCX1_ResDblClick (index as integer)

The ResDblClick event has these parts:

Part | Description
index | An integer expression containing the resource array index

Remarks

The sequence of ScPro Control is

· ResClick

· ResDblClick

To retrieve the user ID, use the ResID property

See Also

ResClick , ResID property

Time Block routines overview

Index

The following routines are used for the Time Block (Tb), Block Links (Link) and style (Bar) management in the Scheduler Pro Control object.

Properties | Methods | Events
TbAva | TbAdd | TbClick
TbBar | TbAllocate | TbDblClick
TbBeg | TbClear | TbBeforeDrag
TbDesc | TbIndexFromID | TbBeforeDrop
TbDur | TbIndexFromKey | LinkClick
TbEnd | TbMove | LinkDblClick
TbGroup | TbBarStyle | TbAfterDrop
TbID | BarAdd |
TbKey | BarClear |
TbMax | BarIndex |
TbRes | LinkAdd |
TbUser | LinkClear |
TbRealDur | LinkHide |
TbRealEnd | LinkShow |
TbLocked | ToolTipRefresh |
TbBook |  |
TbLevel |  |
TbSetUp |  |
TbUrgency |  |
TbResLock |  |
TbParam1 |  |
TbParam2 |  |
BarDesc |  |
BarFillColor |  |
BarMax |  |
ToolTipAfter |  |
ToolTipBefore |  |
ToolTipDesc |  |
ToolTipDur |  |
ToolTipEnd |  |
ToolTipStart |  |
ToolTipUser |  |
ToolTipTitle |  |

TbAva Property

Sets or returns the availability date of an existing time block (the availability date is the starting point from which a time block may be scheduled: before that point it is not available).

Syntax

ScProOCX.TbAva (index As Integer) [ = value ]

The TbDesc property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
index | A numeric expression of the index of an existing time block.
value | A date expression for the time block availability date

Remarks

The availability date is assigned when adding a time block (see TbAdd method and TBbeg value).

The availability date is considered only if the GanttMode >0.

See Also

TbAdd method, TbMove method, TbAllocate method, GanttMode property

TbBar Property

Sets or returns the bar style of an existing time block.

Syntax

ScProOCX.TbBar (index As Integer) [ = value ]

The TbBar property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
index | A numeric expression of the index of an existing time block.
value | A numeric expression for the time block bar style

Remarks

The bar style is assigned when adding a time block (see TbAdd method).

See Also

TbAdd method, TbStyle method, BarAdd method

TbBeg Property

Returns the beginning date of an existing time block.

Syntax

ScProOCX.TbBeg (index As Integer)

The TbBeg property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
index | A numeric expression of the index of an existing time block.

Remarks

The beginning date is assigned when adding a time block (see TbAdd method).

To change the beginning date, the following methods are available

· Drag&Drop manual action

· TbMove method

· TbAllocate method

See Also

TbAdd method, TbMove method, TbAllocate method

TbDesc Property

Sets or returns the description of an existing time block.

Syntax

ScProOCX.TbDesc (index As Integer) [ = value ]

The TbDesc property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
index | A numeric expression of the index of an existing time block.
value | A string expression for the time block description

Remarks

The description is assigned when adding a time block (see TbAdd method).

The description string can be displayed in the time block according to the style bar.

See Also

TbAdd method

TbDur Property

Sets or returns the required duration (in hours) of an existing time block.

Syntax

ScProOCX.TbDur (index As Integer) [ = value ]

The TbDur property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
index | A numeric expression of the index of an existing time block.
value | A numeric (single) expression for the time block duration.

Remarks

The duration is assigned when adding a time block (see TbAdd method).

To position correctly (the modified block may overlap another existing block or a following non-work period may have to be considered) the modified block in the current Gantt the following methods are available:

· TbMove method (different resources)

· TbAllocate method (same resource)

See Also

TbAdd method, TbMove method, TbAllocate method

TbEnd Property

Sets or returns the required end date (delivery date) of an existing time block (it can be used as a scheduling variable).

Syntax

ScProOCX.TBend (index As Integer) [ = value ]

The TBend property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
index | A numeric expression of the index of an existing time block.
value | A date expression for the time block end date (default date with TbAdd method)

Remarks

The end date is assigned when adding a time block (see TbAdd method).

This property can be used as a scheduling variable: remember to set the scheduling logical properties (SchEnd property) before scheduling (SchRun method).

See Also

TbAdd method, SchRun method, SchEnd property

TbGroup Property

Sets or returns the group ID of an existing time block (can be used to tag a group of time blocks).

Syntax

ScProOCX.TbGroup (index As Integer) [ = value ]

The TbGroup property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
index | A numeric expression of the index of an existing time block.
value | A numeric expression for the user time block group ID.

Remarks

The group ID is assigned when adding a time block (see TbAdd method).

For negative group ID values it is possible to handle multi resource time blocks (standing that the GanttMulti property is set to 1: remember that you have to add more then one time block with the same TbGroup value to build a multi resource time block).

Remember that you cannot add more than 1 time block per resource for each multi group.

See Also

TbAdd method

TbID Property

Sets or returns the user ID of an existing time block (can be used to ceate a user numeric index of the time block).

Syntax

ScProOCX.TbID (index As Integer) [ = value ]

The TbID property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
index | A numeric expression of the index of an existing time block.
value | A numeric expression for the user time block ID.

Remarks

The user ID is assigned when adding a time block (see TbAdd method).

See Also

TbAdd method

TbKey Property

Sets or returns the user Key of an existing time block (can be used to ceate a user string index of the time block)

Syntax

ScProOCX.TbKey (index As Integer) [ = value ]

The TbKey property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
index | A numeric expression of the index of an existing time block.
value | A string expression for the user time block Key.

Remarks

The user Key is assigned when adding a time block (see TbAdd method).

See Also

TbAdd method

TbMax Property

Returns the upper bound of the time block array (read only property).

Syntax

ScProOCX.TbMax

The TbMax property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.

Remarks

The lower bound of the time block array is 1. If the lower/upper bound is 0, the array is empty.

See Also

TbAdd method

TbRes Property

Returns the resourse ID of an existing time block (read only property).

Syntax

ScProOCX.TbRes (index As Integer)

The TbRes property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
index | A numeric expression of the index of an existing time block.

Remarks

The resource ID is assigned when adding a time block (see TbAdd method).

To change the resource ID, the following methods are available

· Drag&Drop manual action

· TbMove method

See Also

TbAdd method, TbMove method

TbUser Property

Sets or returns the user string of an existing time block (can be used to store user variables).

Syntax

ScProOCX.TbUser (index As Integer) [ = value ]

The TbUser property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
index | A numeric expression of the index of an existing time block.
value | A string expression for the user time block string.

Remarks

The user string is assigned when adding a time block (see TbAdd method).

The user string can be displayed in the time block according to the style bar.

See Also

TbAdd method

TbRealDur Property

Returns the real duration (in hours) of an existing time block (it includes the duration of any existing non work period during the time block).

Syntax

ScProOCX.TbRealDur (index As Integer)

The TbRealDur property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
index | A numeric expression of the index of an existing time block.

Remarks

The real duration may be longer of the assigned duration because it includes the duration of any non work period during the time block (the time block stretches its duration on non work periods).

See Also

TbRealEnd property

TbRealEnd Property

Returns the real end date of an existing time block (it is the visible end of an allocated time block).

Syntax

ScProOCX.TbRealEnd (index As Integer)

The TbRealEnd property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
index | A numeric expression of the index of an existing time block.

Remarks

The real end date may be after the date calculated from the TbBeg date and the TbDur duration because it includes the any non work period during the time block (it may be calculated from the TbBeg date and the TbRealDur duration).

See Also

TbRealDur property

TbLocked Property

Sets or returns the required lock date of an existing time block (it can be used to lock a time block to a specific date).

Syntax

ScProOCX.TbLocked (index As Integer) [ = value ]

The TbLocked property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
index | A numeric expression of the index of an existing time block.
value | A date expression for the time block lock date.

Remarks

In manual mode (default SchMode=0) once you have assigned the lock date to a time block you should reallocate (see TbAllocate method) to move it to the correct starting point (unless it is already allocated in that point).

In scheduling mode (SchMode=1) the time block is allocated using the SchRun method.

When block overlap is considered (GanttMode>1) if there is no room to allocate the time block then the lock date will not be respected (the time block will be allocated to the first possible point after the lock date).

A time block with a specified lock date cannot be moved by any drag & drop action: before it is necessary to remove the lock date, just setting it to 0 (TbLocked(index)=0).

See Also

TbAdd method

TbBook Property

Sets or returns the booking date of an existing time block (it can be used as a scheduling variable).

Syntax

ScProOCX.TbBook (index As Integer) [ = value ]

The TbBook property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
index | A numeric expression of the index of an existing time block.
value | A date expression for the time block booking date (default date: date of block adding)

Remarks

This property can be used as a scheduling variable: remember to set the scheduling logical properties (SchBook property) before scheduling (SchRun method).

See Also

SchRun method, SchBook

TbLevel Property

Sets or returns the importance level of an existing time block (it can be used as a scheduling variable).

Syntax

ScProOCX.TbLevel (index As Integer) [ = value ]

The TbLevel property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
index | A numeric expression of the index of an existing time block.
value | An integer numeric expression (positive) for the time block importance (default 0)

Remarks

This property can be used as a scheduling variable: remember to set the scheduling logical properties (SchLevel property) before scheduling (SchRun method).

This property is usually set either to 0 (no importance) or 1 (important), but also many levels of importance may be used. Remember that the weight of this variable (SchLevel) is moltiplied by the time block property value (TbLevel): so if different levels from 0 or 1 are used you should pay attention when setting the logical properties (for example if you have the time block importance level TbLevel ranging from 0 to 5, setting the logical property SchLevel to 10 will come out with a real weight ranging from 0 to 50)

See Also

SchRun method, SchLevel

TbSetUp Property

Sets or returns the setup string of an existing time block (it can be used as a scheduling variable).

Syntax

ScProOCX.TbSetUp (index As Integer) [ = value ]

The TbSetUp property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
index | A numeric expression of the index of an existing time block.
value | A string expression for the time block setup code (default “”)

Remarks

This property can be used as a scheduling variable: remember to set the scheduling logical properties (SchSetUp property) before scheduling (SchRun method).

The scheduling algorithm tries to allocate in sequence all the time blocks with the same setup (considering also the other scheduling variables).

See Also

SchRun method, SchSetUp

TbUrgency Property

Sets or returns the urgency of an existing time block (it can be used as a scheduling variable).

Syntax

ScProOCX.TbUrgency (index As Integer) [ = value ]

The TbUrgency property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
index | A numeric expression of the index of an existing time block.
value | An integer numeric expression (positive) for the time urgency (default 0)

Remarks

This property can be used as a scheduling variable: remember to set the scheduling logical properties (SchUrgency property) before scheduling (SchRun method).

This property is usually set either to 0 (no urgency) or 1 (urgent), but also many levels of urgency may be used. Remember that the weight of this variable (SchUrgency) is moltiplied by the time block property value (TbUrgency): so if different levels from 0 or 1 are used you should pay attention when setting the logical properties (for example if you have the time block urgency TbUrgency ranging from 0 to 5, setting the logical property SchUrgency to 20 will come out with a real weight ranging from 0 to 100)

See Also

SchRun method, SchUrgency

TbResLock Property

Sets or returns the required lock resource of an existing time block (it can be used to lock a time block to a specific resource).

Syntax

ScProOCX.TbResLock (index As Integer) [ = action ]

The TbResLock property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
index | A numeric expression of the index of an existing time block.
action | An integer expression (0/1) that sets how time blocks is locked to the resource. The action value is set by adding the below numbers to get the desired behaviour

Settings

Possible settings for action are:

action | Description
0 | The time block is not locked to the resource (default)
1 | The time block is locked to the current resource

Remarks

Methods like SchRun consider this property when balancing the load of a group of resources

Do not confuse TBResLock with TBLocked: the first locks the task to the resource, the second locks the task to a specified starting date .

See Also

TbLocked property

TbParam1 Property

Sets or returns a user parameter (integer number) of an existing time block (can be used to store user variables).

Syntax

ScProOCX.TbParam1 (index As Integer) [ = value ]

The TbParam1 property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
index | A numeric expression of the index of an existing time block.
value | A numeric expression (integer) for the user time block parameter.

Remarks

Do not confuse TbParam1 with TbUser: the first adds a user integer parameter, the second specifies a user string.

See Also

TbAdd method

TbParam2 Property

Sets or returns a user parameter (integer number) of an existing time block (can be used to store user variables).

Syntax

ScProOCX.TbParam2 (index As Integer) [ = value ]

The TbParam2 property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
index | A numeric expression of the index of an existing time block.
value | A numeric expression (integer) for the user time block parameter.

Remarks

Do not confuse TbParam2 with TbUser: the first adds a user integer parameter, the second specifies a user string.

See Also

TbAdd method

BarDesc Property

Returns the description of the style bar array element.

Syntax

ScProOCX.BarDesc (index As Integer)

The BarDesc property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
index | A numeric expression of the index of an existing style bar.

Remarks

The index can be retrieved from the return value of the BarAdd method

The lower bound of the bar array is 1. If the lower/upper bound is 0, the bar is empty.

This property is available only at run time.

See Also

BarAdd method

BarFillColor Property

Sets the fill color of the style bar array element.

Syntax

ScProOCX.BarFillColor (index As Integer) [ = value ]

The BarFillColor property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
index | A numeric expression of the index of an existing style bar.
value | A variant expression for the fill color (decimal or Hex)

Remarks

The index can be retrieved from the return value of the BarAdd method

The lower bound of the bar array is 1. If the lower/upper bound is 0, the bar is empty.

See Also

BarAdd method

BarMax Property

Returns the upper bound of the style bar array (read only property).

Syntax

ScProOCX.BarMax

The BarMax property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.

Remarks

The lower bound of the bar array is 1. If the lower/upper bound is 0, the bar is empty.

See Also

BarAdd method

ToolTip Properties

Sets or returns the tooltip parameters of the time block.

Syntax

ScProOCX.ToolTipAfter [ = value ]

ScProOCX.ToolTipBefore [ = value ]

ScProOCX.ToolTipDesc [ = value ]

ScProOCX.ToolTipDur [ = value ]

ScProOCX.ToolTipEnd [ = value ]

ScProOCX.ToolTipStart [ = value ]

ScProOCX.ToolTipTitle [ = value ]

ScProOCX.ToolTipUser [ = value ]

The ToolTip property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
value | A string expression of the time block tooltip parameter description

Remarks

If the property is set to an empty string, the corresponding parameter will not be visible in the time block tooltip.

Every tooltip property has a default value that can be customized by the user at design and run time.

The time block tooltip properties are considered only if the GanttToolTip property is set to 1.

See Also

GanttToolTip property
TbAdd Method

This method loads the specified time block in the Scheduler Pro Control object (the Lite Edition is limited to 1000 time blocks).

Syntax

ScProOCX.TbAdd (ID As Integer, Key As String, Desc As String, IDres As Integer, TBbeg As Date, TBend As Date, TBdur As Single, TBgroup As Integer, TBbar As Integer [, TBuser As String ])

The TbAdd method has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
ID | A numeric expression for the user time block ID.
Key | A string expression for the user time block Key.
Desc | A string expression for the time block description (may be displayed in the time block depending on the style bar).
IDres | A numeric expression for the ID of the assigned resource.
TBbeg | A date expression of the avialability date and for the possible start date of the time block (depending on the GanttMode property it can move forward depending on resource availability).
TBend | A date expression for the required end date of the time block (depending on the GanttMode property and resource availability it may be fulfilled or disregarded).
TBdur | A numeric expression for the time block duration (in hours).
TBgroup | A numeric expression for the ID of the time block group (tag for blocks having some kind of relationship).
TBbar | A numeric expression for the ID of the style bar to be used to display the time block.
TBuser | A string expression for any user variable (may be displayed in the time block depending on the style bar).

Returns

> 0 - Add was successful (returns the block index)

= 0 - Add failed (an error occurred while adding this block)

Remarks

This method ignores the GanttDropMode Property and the GanttLock Property and behaves according to the GantMode and GanttWin property. Remember that if the TbBeg date is after the end of the gantt end date, the TbAdd method will fail (0 as return value)

The Indexes of the time block array are dynamic (can vary when deleting or adding blocks). It is possible to retrieve the current index of a block with the TbIndexFromID method or the TbIndexFromKey method. Either the ID or the Key should be unique index to be useful.This method automatically sets the availability property (TbAva) to the TBbeg value stated in the TbAdd method: do not confuse the TbAva property (block availability date) with the TbBeg property (block beginning date which can vary according to the starting point of the block) or with the TBbeg value of the TbAdd method (availability date and possible starting date according to the GanttMode and allocation)

Before loading or adding a great number of time blocks you should set the control container visible property to false (after loading set the visible property to true) in order to achieve a better performance.

Other tricks to improve the method performance:

- set the GanttNoSymbol property to 1 (it avoids to display the start symbols)

- set the GanttLink property to 0 (it avoids to display the link symbols)

- set the GanttMode property to the correct value (0 and 1 modes are much faster then 2 or 3)

- do not exceed in specifying the GanttWin interval

To avoid to incur in error 480 (“Can't AutoRedraw image”) or error 7 (“Out of memory”) do not exaggerate the number of time blocks and eventually set the GanttNoSymbol property to 1.

Prerequisites

Before using the TbAdd method remember that:

· The bar styles must be specified before adding time blocks (see BarAdd method)

· The resources must be specified before adding time blocks (see ResAdd method)

· The GanttMode property must be specified before adding time blocks (see GanttMode property)

· The GanttWin property (extent of the scheduling period in days) must be specified before adding time blocks (see GanttWin property)

Notes on time block drag&drop

When a time block is manually moved with the drag&drop function remember that:

· The GanttMode property may require to consider/ignore block overlapping and to consider/ignore non-work periods. The time block to fulfil the GanttMode property may be moved forward to the drop point . If there is no solution the drag&drop will not be accomplished

· The GanttMode property may forbid any drag&drop action before the TBbeg date (no feasibility before the block availability)

· The GanttDropMode property may require the source and target resources to belong to the same group

· The TimeLine property may forbid any drop of time blocks in the past (before the current time, evidenced by the red vertical line)

See Also

BarAdd method, ResAdd method, GanttMode property, GanttDropMode property, GanttWin property, GanttTimeLine property, TbIndexFromID method, TbIndexFromKey method

TbAllocate Method

This method allocates the specified existing time block (finds the first free period in the current resource starting from the given date) in the Scheduler Pro Control object .

Syntax

ScProOCX.TbAllocate (index As Integer [, New_TbBeg As Date ])

The TbAllocate method has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
index | A numeric expression for the index of the time block array .
New_TbBeg | A date expression for the starting date from where to look for a free period.

Returns

> 0 - Allocate was successful (returns the block index)

= 0 - Allocate failed (an error occurred while allocating this block)

Remarks

This method ignores the GanttDropMode Property and the GanttLock Property and behaves according to the GantMode and GanttWin property.

If the date is not specified, then the TbBeg will be considered as default.

Prerequisites

Before using the TbAllocate method remember that:

· The time block must be added before (see TbAdd method)

· The GanttMode property must be specified before adding time blocks (see GanttMode property)

· The GanttWin property (extent of the scheduling period in days) must be specified before adding time blocks (see GanttWin property)

See Also

TbAdd method, GanttMode property, GanttWin property

TbClear Method

This method deletes the specified existing time block in the Scheduler Pro Control object .

Syntax

ScProOCX.TbClear ([Index As Integer ])

The TbClear method has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
Index | A numeric expression for the index of the time block array .

Returns

> 0 - Clear was successful (returns the deleted block index)

= 0 - Clear failed (an error occurred while deleting this block)

Remarks

If Index=0 (or not specified) then all the existing blocks are deleted.

See Also

TbAdd method

TbIndexFromID Method

This method retrieves the time block array index from the user ID in the Scheduler Pro Control object .

Syntax

ScProOCX.TbIndexFromID (ID As Integer)

The TbIndexFromID method has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
ID | A numeric expression for the user ID of the time block array .

Returns

> 0 - Retrieve was successful (returns the block index)

= 0 - Retrieve failed (an error occurred while serching the time block array)

Remarks

To retrieve the index from a string key see the TbIndexFromKey method.

The user ID is assigned when adding a time block (see TbAdd method).

See Also

TbAdd method, TbIndexFromKey method, TbID property

TbIndexFromKey Method

This method retrieves the time block array index from the user Key in the Scheduler Pro Control object .

Syntax

ScProOCX.TbIndexFromKey (key As String)

The TbIndexFromKey method has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
key | A string expression for the user key of the time block array .

Returns

> 0 - Retrieve was successful (returns the block index)

= 0 - Retrieve failed (an error occurred while serching the time block array)

Remarks

To retrieve the index from a numeric ID see the TbIndexFromID method.

The user Key is assigned when adding a time block (see TbAdd method).

See Also

TbAdd method, TbIndexFromID method, TbKey property

TbMove Method

This method moves the specified existing time block to a different resource (finds the first free period in the specified resource starting from the given date) in the Scheduler Pro Control object .

Syntax

ScProOCX.TbMove (index As Integer, New_TbRes As Integer [, New_TbBeg As Date ])

The TbMove method has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
index | A numeric expression for the index of the time block array .
New_TbRes | A numeric expression for target resource
New_TbBeg | A date expression for the starting date from where to look for a free period.

Returns

> 0 - Move was successful (returns the block index)

= 0 - Move failed (an error occurred while allocating this block)

Remarks

This method ignores the GanttLock property and behaves according to the GantMode, GanttWin and GanttDropMode property.

If the date is not specified, then the TbBeg will be considered as default.

Prerequisites

Before using the TbAllocate method remember that:

· The time block must be added before (see TbAdd method)

· The GanttMode property must be specified before adding time blocks (see GanttMode property)

· The GanttWin property (extent of the scheduling period in days) must be specified before adding time blocks (see GanttWin property)

See Also

TbAdd method, GanttMode property, GanttWin property, GanttDropMode property

TbBarStyle Method

This method assigns to the specified existing time block an existing style bar in the Scheduler Pro Control object .

Syntax

ScProOCX.TbStyle (TBindex As Integer , myBar As Integer)

The TbStyle method has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
TBindex | A numeric expression for the index of the time blocks array.
myBar | A numeric expression for the ID of a specified style bar.

Returns

> 0 - Style was successful (returns the modified block index)

= 0 - Style failed (an error occurred while modifying this block)

Remarks

Prerequisites

Before using the TbStyle method remember that:

· The style bar must be added before (see BarAdd method)

· The time block must be added before (see TbAdd method)

See Also

TbAdd method, BarAdd method

BarAdd Method

This method loads the specified style bar (it is a template for the time blocks) in the Scheduler Pro Control object.

Syntax

ScProOCX.BarAdd (ID As Integer, Key As String, Desc As String, Forecolor As Variant, BackColor As Variant, FillStyle As Integer, BarSize As Integer, BarStyle As Integer, Font As String, Font Size As Single, Alignment As Integer, BarTextID As Integer)

The BarAdd method has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
ID | A numeric expression for the user bar ID (unique)
Key | A string expression for the user bar Key.
Desc | A string expression for the bar description
ForeColor | A variant expression for the forecolor of the bar (decimal or Hex)
BackColor | A variant expression for the backcolor of the bar (decimal or Hex)
FillStyle | An integer expression for the user bar style (0 solid, 1 transparent, 2 horizontal line, 3 vertical line, 4 Upword diagonal, 5 Downword diagonal, 6 Cross, 7 Diagonal Cross, 8 Vertical colors, 9 Horizontal colors, 10 Flag colors
BarSize | An integer expression for the bar size in % of the resource height
BarStyle | A numeric expression for the start/end symbol of the bar (0 no symbols, 10 pentagon down start symbol, 20 pentagon up start symbol, 30 arrowhead down start symbol, 40 arrowhead up start symbol)
Font | A string expression for the bar Font Name
FontSize | A numeric expression for the bar Font Size
Alignment | An integer expression for the bar text alignment (0 left, 1 center, 2 right)
BarTextID | A numeric expression for the type of text to be displayed in a time block (0 for time block TBdesc, 1 for time block TBuser)

Returns

> 0 - Add was successful (returns the bar index)

= 0 - Add failed (an error occurred while adding this bar)

Remarks

The Indexes of the style bar array are dynamic (can vary when deleting or adding bars). It is possible to retrieve the current index of a style bar with the BarIndex method. The ID must be a unique index.

When a time block is added (TbAdd method), the style bar is assigned to the added time block.

See Also

BarIndex method , TbAdd method

BarClear Method

This method deletes the specified existing bar style in the Scheduler Pro Control object .

Syntax

ScProOCX.BarClear ([ID As Integer ])

The BarClear method has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
ID | A numeric expression for the user ID of the style bar.

Returns

> 0 - Clear was successful (returns the deleted bar ID)

= 0 - Clear failed (an error occurred while deleting this style bar)

Remarks

If ID =0 (or not specified) then all the existing style bars are deleted.

If any time blocks are allocated in the gantt, bar styles cannot be deleted.

See Also

BarAdd method

BarIndex Method

This method retrieves the style bar array index from the user ID in the Scheduler Pro Control object.

Syntax

ScProOCX.BarIndex (Bar As Integer)

The BarIndex method has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
Bar | A numeric expression for the ID of the style bar

Returns

> 0 - Retrieve was successful (returns the bar index)

= 0 - Retrieve failed (an error occurred while serching the bar array)

Remarks

The user bar ID is assigned when adding a style bar (see BarAdd method).

See Also

BarAdd method

LinkAdd Method

This method loads a logical link (displayed as an arrow from the source to the target) between the specified time blocks in the Scheduler Pro Control object.

Syntax

ScProOCX.LinkAdd (TBindexSource As Integer, TBindexTarget As Integer)

The LinkAdd method has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
TBindexSource | A numeric expression for the source time block array index
TBindexTarget | A numeric expression for the target time block array index

Returns

> 0 - Add was successful (returns the link index)

= 0 - Add failed (an error occurred while adding this link)

Remarks

This method adds the links without displaying them (use the LinkShow method for this purpose). Before using this method remember that you must have loaded the specified time blocks.

The logical links loaded by this method are used by the scheduling method (SchRun) to consider the correct allocation of successors/predecessors.

See Also

GanttLink property, LinkClear method, LinkHide method, LinkShow method

LinkClear Method

This method deletes the logical links of the specified existing time block in the Scheduler Pro Control object .

Syntax

ScProOCX.LinkClear ([Index As Integer ])

The LinkClear method has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
Index | A numeric expression for the index of the time block array .

Returns

> 0 - Clear was successful (returns the deleted link index)

= 0 - Clear failed (an error occurred while deleting this links)

Remarks

If Index=0 (or not specified) then all the existing links are deleted.

See Also

GanttLink property, LinkAdd method, LinkHide method, LinkShow method

LinkHide Method

This method hides (does not display the arrows, but it keeps in memory the logical links) the logical links in the Scheduler Pro Control object .

Syntax

ScProOCX.LinkHide ([Index As Integer ])

The LinkHide method has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
Index | 0

Returns

> 0 - Hide was successful

= 0 - Hide failed (an error occurred while deleting this links)

Remarks

If Index=0 (or not specified) then all the existing links are hidden.

See Also

GanttLink property, LinkAdd method, LinkClear method, LinkShow method

LinkShow Method

This method displays the logical links of the specified existing time block in the Scheduler Pro Control object .

Syntax

ScProOCX.LinkShow ([Index As Integer ])

The LinkShow method has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
Index | A numeric expression for the index of the time block array .

Returns

> 0 - Show was successful (returns the dispayed link index)

= 0 - Show failed (an error occurred while displaying this links)

Remarks

If Index=0 (or not specified) then all the existing links are displayed.

If the link is logical (forward) then is displayed in blue color, otherwise (backward) in red color.

See Also

GanttLink property, LinkAdd method, LinkHide method, LinkClear method

ToolTipRefresh Method

This method refereshes the tooltip text of the specified existing time block in the Scheduler Pro Control object .

Syntax

ScProOCX.ToolTipRefresh ([Index As Integer ])

The ToolTipRefresh method has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
Index | A numeric expression for the index of the time block array .

Returns

> 0 - Refresh was successful (returns the time block index)

= 0 - Refresh failed (an error occurred while refreshing)

Remarks

Useful to refresh the time blocks where some parameters have been changed programmatically with the time block properties (methods or manual drag&drop update automatically the tooltip text).

See Also

GanttToolTip property

TbClick Event

Fires when a mouse click occurs in the time block.

Syntax (Visual Basic)

Private Sub ScProOCX1_TbClick (index As Integer, button As Integer)

The TbClick event has these parts:

Part | Description
index | A numeric expression of the index of the time block.
button | A numeric expression for the mouse button (1 left, 2 right)

Remarks

The sequence of ScPro Control is

· TbClick

· TbDblClick

· TbBeforeDrag

· TbBeforeDrop

· TbAfterDrop

See Also

TbDblClick, TbBeforeDrag, TbBeforeDrop

TbDblClick Event

Fires when a double mouse click occurs in the time block.

Syntax (Visual Basic)

Private Sub ScProOCX1_TbDblClick(index As Integer)

The TbDblClick event has these parts:

Part | Description
index | A numeric expression of the index of the time block.

Remarks

The sequence of ScPro Control is

· TbClick

· TbDblClick

· TbBeforeDrag

· TbBeforeDrop

· TbAfterDrop

See Also

TbClick, TbBeforeDrag, TbBeforeDrop

TbBeforeDrag Event

Fires when the manual drag&drop of a time block starts.

Syntax (Visual Basic)

Private Sub ScProOCX1_TbBeforeDrag (index As Integer, Abort As Boolean)

The TbBeforeDrag event has these parts:

Part | Description
index | A numeric expression of the index of the time block.
Abort | A boolean expression to abort (1) or confirm (0) the drag action.

Remarks

The sequence of ScPro Control is

· TbClick

· TbDblClick

· TbBeforeDrag

· TbBeforeDrop

· TbAfterDrop

See Also

TbClick, TbDblClick, TbBeforeDrag, TbBeforeDrop

TbBeforeDrop Event

Fires when the manual drag&drop of a time block starts.

Syntax (Visual Basic)

Private Sub ScProOCX1_TbBeforeDrop (index As Integer, Abort As Boolean)

The TbBeforeDrop event has these parts:

Part | Description
index | A numeric expression of the index of the time block.
Abort | A boolean expression to abort (1) or confirm (0) the drop action.

Remarks

The sequence of ScPro Control is

· TbClick

· TbDblClick

· TbBeforeDrag

· TbBeforeDrop

· TbAfterDrop

See Also

TbClick, TbDblClick, TbBeforeDrag

LinkClick Event

Fires when a mouse click occurs in the block link.

Syntax (Visual Basic)

Private Sub ScProOCX1_LinkClick (index As Integer, IndexSource As Integer, IndexTarget As Integer)

The LinkClick event has these parts:

Part | Description
index | A numeric expression of the index of the time block.
IndexSource | A numeric expression for the array index of the source block
IndexTarget | A numeric expression for the array index of the target block

Remarks

The sequence of ScPro Control is

· LinkClick

· LinkDblClick

See Also

LinkDblClick

LinkDblClick Event

Fires when a mouse double click occurs in the block link.

Syntax (Visual Basic)

Private Sub ScProOCX1_LinkDblClick (index As Integer, IndexSource As Integer, IndexTarget As Integer)

The LinkDblClick event has these parts:

Part | Description
index | A numeric expression of the index of the time block.
IndexSource | A numeric expression for the array index of the source block
IndexTarget | A numeric expression for the array index of the target block

Remarks

The sequence of ScPro Control is

· LinkClick

· LinkDblClick

See Also

LinkClick

TbAfterDrop Event

Fires when the manual drag&drop of a time block ends.

Syntax (Visual Basic)

Private Sub ScProOCX1_TbAfterDrop (index As Integer)

The Tb After Drop event has these parts:

Part | Description
index | A numeric expression of the index of the time block.

Remarks

The sequence of ScPro Control is

· TbClick

· TbDblClick

· TbBeforeDrag

· TbBeforeDrop

· TbAfterDrop

See Also

TbClick, TbDblClick, TbBeforeDrag, TbBeforeDrop

Scheduler routines overview

Index

The following routines are used for the Scheduler (Sch) management in the Scheduler Pro Control object: the embedded algorithm uses forward and finite capacity scheduling using up to 5 user variables. Sequencing of time blocks connected by logical links and sequencing to match time block setups is also provided.

Properties | Methods | Events
SchBook | SchRun |
SchEnd |  |
SchLevel |  |
SchSetUp |  |
SchUrgency |  |
SchMode |  |

Scheduler Logical Properties

Sets or returns the logical weight of the corresponding scheduling variables (n°5).

Syntax

ScProOCX.SchBook [ = value ] : weight of the booking date variable (see TbBook)

ScProOCX.SchEnd [ = value ] : weight of the delivery date variable (see TbEnd)

ScProOCX.SchLevel [ = value ] : weight of the importance level variable (see TbLevel)

ScProOCX.SchSetUp [ = value ] : weight of the setup sequencing variable (see TbSetUp)

ScProOCX.SchUrgency [ = value ] : weight of the urgency variable (see TbUrgency)

The property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
value | A positive numeric expression (integer) for the logical weigth to be assigned to the corresponding scheduling variable

Remarks

If the property is set to 0, the corresponding variable will not be considered when scheduling (see SchRun method).

Every property has a default value that can be customized by the user at design and run time.

Usually the logical properties are set to a value in the range form 0 to 100, but it is not mandatory.

The greater is the property value, the greater will be the consideration of the corresponding variable when scheduling.

Consider that is very important the value difference between the different logical properties: for example if the delivery date is your heighest priority you should set the corresponding weigth the heigher value (say 100) and the other logical properties to a lower value (such as 60 or even lower).

Remember that if you set the logical properties to very different values (such as 100 and 1), your scheduling will most likely look like a simple time block reordering according to the enabled variables.

See Also

SchRun method
SchMode Property

Sets or returns the scheduling mode .

Syntax

ScProOCX.SchMode [ = action ]

The SchMode property has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
action | An integer expression that sets the scheduling. The action value is set by adding the below numbers to get the desired behaviour.

Settings

Possible settings for action are:

action | Description
0 | The TbAdd method adds, allocates and displays the time blocks (default manual mode)
1 | The TbAdd method adds the time blocks without allocating/displaying them (scheduling mode: after adding the time blocks it is necessary to use the SchRun method for allocating/displaying them)

Remarks

The default action is 0.

If you have added some time blocks in scheduling mode (action =1) you cannot add or delete a time block or display the logic links (LinkShow method) until you schedule (SchRun method) or clear all the time blocks (TbClear).

The SchRun method automatically sets this property to 0 after scheduling.

See Also

SchRun method

SchRun Method

This method (available only in Pro Edition ) schedules all the loaded time blocks (with the TbAdd method according to the SchMode property) considering up to 5 variables in the Scheduler Pro Control object .

Syntax

ScProOCX.SchRun ( [mode As integer])

The SchRun method has these parts:

Part | Description
ScProOCX | An object expression that evaluates the Scheduler Pro Control object.
mode | An integer numeric expression for the algorithm mode (future developments)

Returns

> 0 - Scheduling was successful

= 0 - Scheduling failed (an error occurred while scheduling)

Remarks

This method behaves according to the GantMode, ResMode (>1 for finite capacity scheduling), GanttWin (setting of time window to consider for scheduling) and GanttBalance (load balancing on resources of the same group) properties.

The scheduling algorithm (forward scheduling) considers the following:

· The time blocks added with the TbAdd method (regardless of the SchMode property)

· The logical links added with LinkAdd method (block logical sequences: for example if you have some blocks to be executed in sequence, the algorithm will allocate them in order to satisfy the sequence)

· The scheduler logical properties (SchBook, SchEnd, SchLevel, SchSetUp, SchUrgency)

· The time block scheduling variables (TbBook, TbEnd, TbLevel, TbSetUp, TbUrgency)

· The time block lock date: if it is possible it is satisfied

· The time block description (TbDesc): it allocates the time blocks with the same scheduling weight (calculated by the algorithm) in order of description (ascending)

· If the GanttBalance property is >0 then it balances the scheduled load on the resources of the same group

The SchRun method automatically sets the SchMode property to 0 after scheduling (in order to enable the manual mode)

The SchRun method automatically shows the logical links (Showlink method) after scheduling if the GanttLink property is set to 1.

How to schedule

You should follow the following steps:

1) Set the SchMode to 1

2) Set the scheduler logical properties (SchBook, SchEnd, SchLevel, SchSetUp, SchUrgency)

3) Add any missing time block using the TbAdd method: set the scheduling variables (TbBook, TbEnd, TbLevel, TbSetUp, TbUrgency) of every time block if needed (they all get a default value)

4) Add any required link between the time blocks (AddLink)

5) Apply the SchRun method: this method requires some time to process all the time blocks (it can take from some seconds to some minutes, dipending on the number of time blocks and links)

6) Remember to check the return value of this method: ScRun may fail to schedule time blocks that have no solution (no room to fit them on the resource considering the assigned Gantt time interval)

See Also

TbAdd method, SchMode property, Scheduler logical properties, TbBook property , TbEnd property, TbLevel property, TbSetUp property, TbUrgency property