The Scheduler Pro
Control object routines are divided in 5
main categories:
|
Category |
Description |
|
Calendar and
non-work period (properties, methods, events) |
|
|
Gantt, panel
and overall management (properties, methods, events) |
|
|
Resources
(properties, methods, events) |
|
|
Time block,
style bars and links (properties, methods, events) |
|
|
Scheduler only in Pro Edition (properties, methods, events) |
The following
routines are used for the Calendar (and
Non-work) management in the Scheduler Pro Control object.
|
|
|
|
|
|
||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
The following
routines are used for the Gantt
management in the Scheduler Pro Control object.
|
|
|
|
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
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
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
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
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
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
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) |
|
3 |
Buttons
(print) disabled, (open, save, lock, clear , zoom in, zoom out) enabled |
|
4 |
Buttons
(lock) disabled, (open, save, print, clear , zoom in, zoom out) enabled |
Remarks
The default
value is 2 (Panel enabled and visible).
The buttons
open and save generate a click event.
The zoom buttons are limited to 5 zoom in clicks, and 5 zoom out clicks
See Also
GanttOpenClick event, GanntSaveClick
event
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
Sets or
returns the error message (run time property)
.
Syntax
ScProOCX.GanttLastError
[ = value ]
The GanttLastError
property has these parts:
|
Part |
Description |
|
ScProOCX |
An object expression
that evaluates the Scheduler Pro Control object. |
|
value |
A string
expression that resets error message (default: empty string). |
Remarks
The default value is the empty string. When an error occurs (using TbAdd, ScRun, GanttPan,
GanttZoom or Zoom buttons), the error message can be retrieved with this
property.
After
retrieving the message, you can reset the property assigning to it an empty
string.
See Also
Sets or
returns the time block color gradient (design and run time property) .
Syntax
ScProOCX.GanttGrad
[ = action ]
The GanttGrad
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 gradient 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 |
No color
gradient in time block (default) |
|
1 |
Vertical color
gradient in time block (from background color to white) |
Remarks
The default action is 0. This property is available at design and run
time.
Bicolor
backgrounds are not effected by this property.
Methods such as TbAdd or GanttPan are much faster if you set this
property to 0.
See Also
Sets or
returns the time block buffer (design and run time property) .
Syntax
ScProOCX.GanttTbBuffer
[ = value ]
The GanttTbBuffer
property has these parts:
|
Part |
Description |
|
ScProOCX |
An object
expression that evaluates the Scheduler Pro Control object. |
|
value |
An integer
expression that sets the time block buffer (default 100). |
Remarks
The default value is 100. Setting this buffer to the correct value
speeds up loading and displaying time blocks.
Set it to your medium (not maximum, otherwise you slow down the
performance!) number of handled time
block .
Methods such as TbAdd or ScRun are faster if you set this property to the
correct value.
See Also
Sets or
returns the gantt redraw behaviour (design and run time property) .
Syntax
ScProOCX.GanttReadraw
[ = action ]
The GanttRedraw
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 redraw behaviour. The action value is
set by adding the below numbers to get the desired behaviour. |
Settings
Possible
settings for action are:
|
action |
Description |
|
0 |
Gantt window
is not updated |
|
1 |
Gantt window
is updated (default) |
Remarks
The default action is 1. This property is available at design and run
time.
This property
is useful when adding great quantities of time blocks to the gantt: setting
this property to 0 before heavy operations (such as multiple TbAdd or ScRun)
and after setting it back to 1 ensures a better performance.
See Also
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
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
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
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
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
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
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
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
This method
prints the specified gantt information (provided on a list base) to the
specified output in txt format.
Syntax
ScProOCX.GanttPrintTxt
(Output 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. |
|
Output |
Complete
path of the output file or printout: if set to empty string ""
or set to "PRINTER" prints directly to default printer |
|
Title |
Title
to be inserted in the file or printout |
|
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 txt file just invoke your favourite program stating the txt file path.
See
Also
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
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
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
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
The following
routines are used for the Resource
management in the Scheduler Pro Control object.
|
|
|
|
|
|
||
|
|
||
|
|
||
|
|
||
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
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
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
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
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