SchedPro

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

Category	Notes
Calendar	Calendar and non-work period management (properties, methods, events)
Gantt	Gantt, panel and overall management (properties, methods, events)
Resources	Resource management (properties, methods, events)
Time Blocks	Time block, style bar and link management (properties, methods, events)
Scheduler	Scheduler management: 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 [ = value ]

The CalFont property has these parts:

Part	Description
ScProOCX	An object expression that evaluates the Scheduler Pro Control object.
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.

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 .