C++ Methods

See an example C++ Program (html)

See Also: Color numbering, Symbol Numbering, Fade Types,
Horizontal Connector Numbering, Vertical Connector Numbering,
Line Patterns, Fill Patterns, Text Positions, Symbol Shapes

mlsActivate
mlsAddCurtain
mlsAddFreeText
mlsAddSymbol
mlsAddTaskUsingDuration
mlsApplyColorTheme
mlsCheckForDiskFileSave
mlsCheckForEscapeKey
mlsClearValueSet
mlsClearValueSetByNumber
mlsClose
mlsConvertUserHeadToEmbedded
mlsCopyMetaFileToClipboard
mlsDeleteCurrentPage
mlsDeleteSymbol
mlsDeleteTaskLine
mlsDisplayMessageBox
mlsFilterTaskLines
mlsGetCellTag
mlsGetCellText
mlsGetColumnProperty
mlsGetCurrencySymbol
mlsGetCurrentDate
mlsGetCurrentPage
mlsGetDataGraphProperty
mlsGetFirstWeeklyValueSetDate
mlsGetFontSize
mlsGetFreeTextProperty
mlsGetGlobalValueSetValue
mlsGetLegendProperty
mlsGetLineOfSymbolTag
mlsGetLinesPerPage
mlsGetNumberOfFreeTextBlocksUsed
mlsGetNumberOfPages
mlsGetMetric
mlsGetMilestonesDateFormat
mlsGetMilestonesSystemFolder
mlsGetMiscProperty
mlsGetNumberOfLines
mlsGetNumberOfSymbolsInLine
mlsGetOutlineLevel
mlsGetOutlineLevelAttribute
mlsGetPercentComplete
mlsGetScheduleHeight
mlsGetSelectedSymbolInLine
mlsGetSymbolNumberOfSymbolTag
mlsGetSymbolProperty
mlsGetTaskLineOfSelectedSymbol
mlsGetTaskLineValueSetValue
mlsGetTitle1
mlsGetTitle2
mlsGetTitle3
mlsGetToolboxSymbolProperty
mlsGetValueSetDateAlignment
mlsKeepScheduleOpen
mlsMaximizeWindow
mlsPrint
mlsPutCell
mlsPutCellTag
mlsRefresh
mlsRefreshTask
mlsResetEscapeKey
mlsRollUpTaskLines
mlsSave
mlsSaveBitmap
mlsSaveHTML
mlsSaveHTMLDrillDown
mlsSelectSymbolInLine
mlsSetAutomationDependencyMode
mlsSetAutoSave
mlsSetCalculationColumnProperties
mlsSetCalendarView
mlsSetColumnProperty
mlsSetColumnWidth
mlsSetConnectorFillToStatus
mlsSetCurrentDate
mlsSetCurrentPage
mlsSetCurtainProperties
mlsSetCustomColor
mlsSetDataGraphProperty
mlsSetDateHeading
mlsSetDateHeadingProperty
mlsSetDebugMode
mlsSetDisplayedStartEndTimes
mlsSetEndDate
mlsSetFontSize
mlsSetFontStyle
mlsSetFrameAndBackgroundOptions
mlsSetFreeTextProperty
mlsSetGlobalSymbolSize
mlsSetGlobalValueSetValue
mlsSetHideBaseLineSummaryBar
mlsSetHolidayCalendar
mlsSetInternetPublishingOptions
mlsSetLegendHeight
mlsSetLegendProperty
mlsSetLegendSymbology
mlsSetLegendText
mlsSetLinesPerPage
mlsSetMiscProperty
mlsSetOutLineLevel
mlsSetOutLineLevelAttribute
mlsSetPageSize
mlsSetPageStartEndDates
mlsSetPercentComplete
mlsSetScheduleGridlinesAndShades
mlsSetShowLinks
mlsSetStartDate
mlsSetStartAndEndDates
mlsSetStatusMessage
mlsSetSummaryBarDisplay
mlsSetSymbolDateFormat
mlsSetSymbolFillToStatus
mlsSetSymbolProperty
mlsSetTaskLineFontHeight
mlsSetTaskLineFontStyle
mlsSetTaskLineGrid
mlsSetTaskLineHeight
mlsSetTaskLineShade
mlsSetTaskLineShadeEffects
mlsSetTaskLineValueSetValue
mlsSetTitle1
mlsSetTitle2
mlsSetTitle3
mlsSetTitleProperty
mlsSetToolboxHorizontalConnectorProperty
mlsSetToolboxVerticalConnectorProperty
mlsSetToolboxProperty
mlsSetToolboxSymbolProperty
mlsSetValueSetDateAlignment
mlsSetValueSetName
mlsSetValueSetProperty
mlsSetWorkdayStartEndTimes
mlsShowAllTaskLines
mlsSortSymbols
mlsTemplate
mlsToggleContinuousView
mlsToolbar
mlsToolbox
mlsUse20Columns  


mlsActivate   back to top

Purpose: This call causes the Milestones Professional window to come to the foreground on the screen.
Return Value: None
Arguments: None

mlsAddCurtain   back to top Purpose: Add curtains shading date ranges on a schedule. Return Value: None Arg. Type Purpose Curtain starting date and time Curtain ending date and time
1 String
2 String
 

mlsAddFreeText   back to top Purpose: This method is used to add a block of freeform text. Return Value: None Arg. Type Purpose
1 String Text to add
2 Double X Position, the position in inches from the left edge. Must be positive.
3 Double Y Position, the position in inches from the top edge. Must be positive.
 

mlsAddSymbol   back to top Purpose: This command is used to add a symbol to a task row. Return Value: None Arg. Type Purpose
1 Integer Task Row (1 based)
2 String Symbol Date (in short date form based on regional settings) e.g. m/d/y
3 Integer 1-32, identifying the symbol in the toolbox.
4 Integer Horizontal connector type from toolbox (1-16).
5 Integer Horizontal connector index (symbol that this symbol connects to (1 based)
6 Integer Vertical connector type from this symbol (1-8)
7 Integer Vertical connection task row of symbol that this symbol connects to (1 based)
8 Integer Vertical connection symbol index of symbol that this symbol connects to (1 based)
9 Integer Symbol hour (0-23)
10 Integer Symbol minute (0-59)
11 String Symbol text line 1 (58 chars max)
12 String Symbol text line 2 (58 chars max)
13 String Symbol text line 3 (58 chars max)
14 String Symbol legend text (58 chars max)
 

mlsAddTaskUsingDuration   back to top

Purpose: This command is used to create a task in a task row using a starting date plus duration. Return Value: None Arg. Type Purpose
1 Integer Task Row (1 based)
2 String Symbol Date (in short date form based on regional settings) e.g. m/d/y
3 Integer Starting Symbol type from toolbox (1-32)
4 Integer Starting Horizontal connector type from toolbox (1-16)
5 Integer Reserved for future use
6 Integer Symbol type for second symbol from toolbox (1-32)
7 Integer Duration
8 String Duration Type, set to "Day", "Hour", or "Minute", depending upon the units of argument 7.
9 Integer Starting Symbol hour (0-23)
10 Integer Starting Symbol minute (0-59)
11 String Starting Symbol text line 1 (58 chars max)
12 String Starting Symbol text line 2 (58 chars max)
13 String Starting Symbol text line 3 (58 chars max)
 

mlsApplyColorTheme   back to top

Purpose: This command is used to apply a color theme Return Value: None Arg. Type Purpose
1 String Theme Name
2 Double "True" or "False" to control whether or not to set all task lines to outline level theme
 

mlsCheckForDiskFileSave   back to top

Purpose: This command affects behavior when the program closes the current window. Return Value: None Arg. Type Purpose
1 String "On" or "Off". If the parameter is set to "Off", Milestones will not display the file save dialog box. If the parameter is "On", the file save dialog will be displayed (unless the file has already been saved).
 

mlsCheckForEscapeKey   back to top

Purpose: This command returns True if the user has pressed the Escape key Return Value: String, "True" or "False" Arg. Type Purpose
1 String Return String ("True" or "False")
 

mlsClearValueSet   back to top

Purpose: This command is used to clear a ValueSet. When used, all values for global, taskline and symbol ValueSets are cleared. Return Value: None Arg. Type Purpose
1 String The ValueSet Name
 

mlsClearValueSetByNumber   back to top

Purpose: Clear a ValueSet, referencing the ValueSet by its index (1-9) instead of it's name. Returns: none Arg. Type Purpose
1 Integer Index of the ValueSet (1-9)
 

mlsClose   back to top

Purpose: This command is used to close the current schedule. Return Value: None   Arg. Type Purpose
1 String If "NoSave" then file closes immediately without asking user to first save file, even if the file has been altered without being saved. If the string has any other valid value, it will ask to save.
 

mlsConvertUserHeadToEmbedded   back to top

Purpose: This command is used to force the custom date heading specified to be saved with the schedule. Return Value: None Arg. Type Purpose
1 Integer Indicates the heading level (1-4)
 

mlsCopyMetafileToClipboard    back to top

Purpose: Copy a metafile of the current page to the clipboard. Useful for incorporating schedules in other documents on the fly. Has the same effect as choosing the Copy Metafile to Clipboard option on the Milestones Professional Edit menu. Return Value: None Arguments: None  

mlsDeleteCurrentPage   back to top

Purpose: This command is used to delete the current page. Return Value: None Arguments: None  

mlsDeleteSymbol   back to top

Purpose: This command is used to delete a symbol from a task row. Return Value: None Arg. Type Purpose
1 Integer Task Row (1 based)
2 Integer Symbol Number (1 based)
 

mlsDeleteTaskLine   back to top

Purpose: This command is used to delete a task row. Return Value: None Arg. Type Purpose
1 Integer Task Row (1 based)
 

mlsDisplayMessageBox   back to top

Purpose: Displays a message box in Milestones. Return Value: None Arg. Type Purpose
1 String Text message to display.
 

mlsFilterTaskLines   back to top

Purpose: This command is used to filter task lines. Returns: none Arg. Type Purpose
1 String 0,1,...20 (0 means filter all columns 1-20 means only columns 1-20)
2 String Filter 1 Type - "AND","OR",or "NOT"
3 String Filter 1 Text - Filter String
4 String Filter 2 Type - "AND","OR",or "NOT"
5 String Filter 2 Text - Filter String
6 String Filter 3 Type - "AND","OR",or "NOT"
7 String Filter 3 Text - Filter String
8 String Filter 4 Type - "AND","OR",or "NOT"
9 String Filter 4 Text - Filter String
10 String Filter 5 Type - "AND","OR",or "NOT"
11 String Filter 5 Text - Filter String
12 String Filter 6 Type - "AND","OR",or "NOT"
13 String Filter 6 Text - Filter String
14 String Filter 7 Type - "AND","OR",or "NOT"
15 String Filter 7 Text - Filter String
16 String Filter 8 Type - "AND","OR",or "NOT"
17 String Filter 8 Text - Filter String


mlsGetCellTag   back to top

Purpose: Returns the tag from a description cell Returns: String Arg. Type Purpose
1 String Return String
2 Integer Task line
3 Integer Column
 

mlsGetCellText   back to top

Purpose: This command is used to obtain the text from a description cell. Returns: String. (Text from the indicated cell) Arg. Type Purpose
1 String Return String
2 Integer Task Row (1 based)
3 Integer Column (1-20)
 

mlsGetColumnProperty   back to top

Purpose: This command is used to determine if a column is a SmartColumn and if so, which type. Return Value: Variant (see list below) Arg. Type Purpose
1 String Return String
2 Integer Column (1-20)
3 String Desired Property from list below
"SmartColumn" returns Smartcolumn type from list below
   "None"
  "StartDate"
  "EndDate"
  "Duration"
  "PercentComplete"
  "TaskNumber"
  "OutlineLevel"
  "WBSNumber"
  "StatusDate"
  "UsedDuration"
  "RemainingDuration"
  "TimeAheadBehind"
  "BaselineStart"
  "BaselineEnd"
  "BaselineDuration"
  "ValueSet-1 to ValueSet-9" (Make sure you are using a ValueSet of type 2 or 4).
  "Values"
  "SymbolCount"
  "Calculation"
"IndicatorSymbolSize" Returns double indicator symbol size
"Width" Returns double width
 

mlsGetCurrencySymbol   back to top

Purpose: This command is used to determine which symbol is in use as the default currency symbol. Returns: String Arg. Type Purpose
1 String Return String
 

mlsGetCurrentDate   back to top

Purpose: Returns the current date from the schedule Returns: String Arguments: None Arg. Type Purpose
1 String Return String
 

mlsGetCurrentPage   back to top

Purpose: Use this to obtain the current page number. Returns: Integer, the current page number Arg. Type Purpose
1 Integer Return Integer
 

mlsGetDataGraphProperty   back to top

Purpose: This command is used to get properties of a free-form text block (returns property) Returns: Double or Int as a String, the requested property value. See property for correct type. Arg. Type Purpose
1 String Return Value
2 Integer DataGraph - 1 based (1-3)
3 String Desired Property from list below
"Height" returns double height in inches
"Visible" returns int 1 or 0
"TextHeight" returns int font size (3-72)
"MaxValue" returns double
"MinValue" returns double
"Increment" returns double
"NumberOfIncrements" returns int
 

mlsGetFirstWeeklyValueSetDate   back to top

Purpose: This command is used to return the first week's ending date. Useful for adding values to a ValueSet. Returns: String, Date. "mm/dd/yyyy", using current date order (set in Control Panel - short date). Always uses 4 digit year. Arg. Type Purpose
1 String Return String
 

mlsGetFontSize   back to top

Purpose: This command is used to obtain the font size of a certain area on the schedule. Returns: Integer (font size) Arg. Type Purpose
1 Integer Return Value
2 Integer Area of schedule Area of schedule to set
  1. Column Text (set this before adding task lines)
  2. Symbol Text
  3. Title line 1
  4. Title line 2
  5. Title line 3
  6. Date heading 1
  7. Date heading 2
  8. Date heading 3
  9. Date heading 4
  10. Page number
  11. Current date
  12. Column heading 1
  13. Column heading 2
  14. Column heading 3
  15. Column heading 4
  16. Column heading 5
  17. Column heading 11
  18. Column heading 12
  19. Column heading 13
  20. Column heading 14
  21. Column heading 15
  22. Legend
  23. DataGraph
24-28=Column Head 6-10 on left 29-33=Column Head 16-20 on right
 

mlsGetFreeTextProperty   back to top

Purpose: This command is used to get properties of a free-form text block (returns Returns: Double as a string, Int as a string, or just a string; the requested property value. See property for correct type. Arg. Type Purpose
1 String Return Value
2 Integer TextBlock - 1 based (use 0 if asking for number of blocks)
3 String Desired Property from list below
"XPos" returns double xpos in inches
"YPos" returns double ypos in inches
"Page" returns int page number (1 based)
"Border" returns int 0 or 1
"Transparent" returns int 0 or 1
"Shadow" returns 0 or 1
"BackGroundColor" returns int 0 to 18
"ShadowColor" returns int 0 to 18
"TextColor" returns int 0 to 18
"TextHeight" returns int 4 to 72
"UnderLine" returns int 0 or 1
"Bold" returns int 0 or 1
"Italic" returns int 0 or 1
"TextAlign" returns int 0 (left) 1 (center) or 2 (right)
"TagInfo" returns text (1 to 39 bytes)
"FontName" returns text (1 to 59 bytes)
"Text" returns text (1 to 1998 bytes)
"NumberOfBlocks" returns int 1 based number of free-form text blocks
 

mlsGetGlobalValueSetValue   back to top

Purpose:This command is used to obtain the ValueSet value for a specified date. Returns: A double value is returned. Return variant must exist or there is an error. Arg. Type Purpose
1 Double Return Value
2 String ValueSet Name or number.
3 String The date of the value to be retrieved, using the current date order.
 

mlsGetLegendProperty   back to top

Purpose: This command is used to get an attribute of an outline level. Returns: Int or Double as a string. Arg. Type Purpose
1 String Return Value
2 Integer Legend entry index (1-30 or 0 for general property)
3 String Property to get
"Height" returns double height in inches
"TextHeight" returns int text size
"TotalNumberOfEntries" returns int total number of entries
"NumberOfEntriesPerLine" returns int number of entries per line
"SymType1" returns int 1 based index into toolbox
"SymType2" returns int 1 based index into toolbox
"ConnType" returns int 1 based index into toolbox
"VConnType" returns int 1 based index into toolbox
 

mlsGetLineOfSymbolTag   back to top

Purpose: This command is used to get the task number for the first symbol with the specified tag. Returns: Integer, the task index of the first row which contains a symbol with the specified tag. Arg. Type Purpose
1 Integer Return Value
2 String SymbolTag
 

mlsGetLinesPerPage   back to top

Purpose: This command is used to obtain the number of lines per page for the schedule. Returns: Integer; The number of lines per page. Arguments: None Arg. Type Purpose
1 Integer Return Integer
 

mlsGetNumberOfFreeTextBlocksUsed   back to top

Purpose: Use this to obtain the current number of free text blocks. Returns: Integer, the current number of free text blocks Arg. Type Purpose
1 Integer Return Integer
 

mlsGetNumberOfPages  back to top

Purpose: Use this to obtain the current number of pages on the schedule. Returns: Integer, the current number of pages Arguments: None Arg. Type Purpose
1 Integer Return Integer
 

mlsGetMetric   back to top

Purpose: This command is used to determine whether metric units are set as the default on the user's system. Returns: Integer 0 for English measurements, or 1 for metric. Arg. Type Purpose
1 Integer Return Integer
 

mlsGetMilestonesDateFormat   back to top

Purpose: This command is used to get the date format Milestones is using. Milestones picks up the date format from Windows' "short date" format Returns: Integer (0-2) Arguments: None Arg. Type Purpose
1 Integer Return Integer
 

mlsGetMilestonesSystemFolder   back to top

Purpose: This command is used to get the full path of the Milestones system folder. Returns: String containing the current system folder for Milestones. Arg. Type Purpose
1 String Return String
 

mlsGetMiscProperty   back to top

Purpose:This command is used get misc. properties. Returns: String with a double value. Arg. Type Purpose
1 String Return Value
2 String Misc. Property ("Symbol Size" returns global symbol size as double. This is the only supported property right now)
 

mlsGetNumberOfLines   back to top

Purpose:This command is used to obtain the number of task rows currently allocated in the schedule. Returns: Integer; The number of task rows in the schedule (1 based) Arg. Type Purpose
1 Integer Return Integer
 

mlsGetNumberOfSymbolsInLine   back to top

Purpose:This command is used to obtain the number of symbols on any given task row of the schedule. Returns: Integer; The number of symbols on the task row. (1 based) Arg. Type Purpose
1 Integer Return Value
2 Integer Task Row (1 Based)
 

mlsGetOutlineLevel   back to top

Purpose: This command is used to obtain the current outline level of the task row. Returns: Integer; Outline level (1-9) Arg. Type Purpose
1 Integer Return Value
2 Integer Task Row (1 based)
 

mlsGetOutlineLevelAttribute   back to top

Purpose: This command is used to get an attribute of an outline level. Returns: Integer. Arg. Type Purpose
1 Integer Return Value
2 Integer Which outline level (1-20)
3 String Property to get
"Fontsize" returns int 3 to 72
"Bold" returns int -1, 0 or 1
"BoldItalic" returns int -1, 0 or 1
"Italic" returns int -1, 0 or 1
"Underline" returns int -1, 0 or 1
"Color" returns int -1, 0 to 18
 

mlsGetPercentComplete   back to top

Purpose: This command is used to get a task's percent complete. Returns: Double-Percent Complete for the task Arg. Type Purpose
1 Double Return Value
2 Integer Task Row (1 based)
 

mlsGetScheduleHeight   back to top

Purpose: This command is used to obtain the height (in inches) of the schedule area. Useful for computing how big the symbols and text should be. Returns: Floating point value Arg. Type Purpose
1 Double Return Value
 

mlsGetSelectedSymbolInLine   back to top

Purpose: This command is used to determine which, if any, symbol is selected by the user Returns: Integer; The 1 based index of currently selected symbol in line, or 0 or -1 Arg. Type Purpose
1 Integer Return Value
2 Integer Task Line (1 based)
 

mlsGetSymbolNumberOfSymbolTag   back to top

Purpose: This command is used to get the symbol index for the symbol with the specified tag. Returns: Integer, the symbol index of the first symbol which contains a symbol with the specified tag. Arg. Type Purpose
1 Integer Return Value
2 Integer SymbolTag
 

mlsGetSymbolProperty   back to top

Purpose: Returns information about a specified symbol on the current schedule. Returns: Int as string, Double as string, or just a string. This is usually an Integer (within a Variant), but the date, symbol text, and symbol note properties are returned as strings (within a Variant). Arg. Type Purpose
1 String Return Value
2 Integer Task Row (1 based)
3 Integer Symbol Number (1 based)
4 String Desired Property from list below:
   
"Date" returns m/d/y in short date format as defined by your regional settings in the Windows Control panel.
"DateBack" returns "Transparent" or "Opaque"
"HorizontalConnection" returns index to horizontal connected symbol (1 based) - or 0 if not used. Sub-Property is 1 or 2 for 1st or 2nd connector. First connector assumed if no Sub-Property.
"HorizontalConnectorType" returns type of horizontal connector from toolbox (1-16) or 0 if no connector. Sub-Property is 1 or 2 for 1st or 2nd connector. First connector assumed if no Sub-Property.
"RollUpToSummaryBar" returns "On" or "Off" to indicate whether the symbol is rolled up to the summary bar.
"SymbolHour" returns (0-23), the hour that the symbol has been placed at.
"SymbolHyperLink" returns the hyperlink string associated with the symbol if any. Note that each link ends with ||. There may be 4 | characters at end.
"SymbolMinute" returns (0-59), the minute that the symbol has been placed at.
"SymbolNotes" returns the note string associated with the symbol if any.
"SymbolSize" returns the symbol size as a floating point value
"SymbolText" returns the requested line of symbol text. Sub-Property is 1 - 3 for 1st - 3rd symbol text line. Sub-Property is required for this property.
"SymbolTextPosition" returns the symbol text position using the same values as SetSymbolProperty.
"SymbolType" returns 1-32.
"TextBack" returns "Transparent" or "Opaque"
"ValueSetValue" returns value or 0.0, Arg 4 is 1-9, indicating which ValueSet.
"VerticalConnectionLineIndex" returns index to connected line (1 based) or 0 if not used). Sub-Property is 1 - 5 for 1st - 5th connector. First connector assumed if no Sub-Property.
"VerticalConnectionSymbolIndex" returns index to connected symbol on connected line (1 based) or 0 if not used. Sub-Property is 1 - 5 for 1st - 5th connector. First connector assumed if no Sub-Property.
"VerticalConnectorType" returns type of vertical connector from toolbox (1-8). Sub-Property is 1 - 5 for 1st - 5th connector. First connector assumed if no Sub-Property.
 

mlsGetTaskLineOfSelectedSymbol   back to top

Purpose: This command is used to determine the task line of the currently selected symbol. Returns: The 1 based index of the task line of the currently selected symbol in line, or 0 or -1 Arg. Type Purpose
1 Integer Return Value
 

mlsGetTasklineValueSetValue   back to top

Purpose: This command is used to retrieve a valueset value. Return Value: Double, Valueset value Arg. Type Purpose
1 Double Return Value
2 Integer The index for the task line.
3 String The name of the ValueSet
4 String The date for which you want to retrieve a value (mm/dd/yy)
 

mlsGetTitle1   back to top

Purpose: This command is used to retrieve the first of the 3 possible Title lines. Returns: String Arg. Type Purpose
1 String Return String
 

mlsGetTitle2   back to top

Purpose: This command is used to retrieve the second of the 3 possible Title lines. Returns: String Arg. Type Purpose
1 String Return String
 

mlsGetTitle3   back to top

Purpose: This command is used to retrieve the third of the 3 possible Title lines. Returns: String Arg. Type Purpose
1 String Return String
 

mlsGetToolboxSymbolProperty   back to top

Purpose: Retrieves the type of symbol in the toolbox. Either the symbol shape or the symbol usage (Normal, Status, Comment, Baseline). Return Value: Int as string, or just a string. Arg. Type Purpose
1 String Return String
2 Integer Symbol number in the toolbox (1 based). See symbol numbering.
3 String The property to get. "Shape" - returns an integer 1-96 representing the symbol shape index. "Usage" - returns the usage set for that toolbox symbol. Possible values: "Normal", "Status", "Comment", "Baseline"
4 Integer Unused but required.
 

mlsGetValueSetDateAlignment   back to top

Purpose: This command is used to retrieve the alignment for the schedule's ValueSets (all have the same alignment) Return Value: String, Value "Daily" or "Weekly" or "Monthly" or "Yearly" Arg. Type Purpose
1 String Return String
 

mlsKeepScheduleOpen   back to top

Purpose: This command attempts to force Milestones to keep the active schedule open even if the controlling application terminates. Returns: None  

mlsMaximizeWindow   back to top

Purpose: This command maximizes the user's window. Returns: None  

mlsPrint   back to top

Purpose: This command is used to print the current schedule. Returns: None Arg. Type Purpose
1 Integer Starting Page Number
2 Integer Ending Page Number
 

mlsPutCell   back to top

Purpose: This command is used to place text into a description cell. Return: None Arg. Type Purpose
1 Integer Task Row (1 based)
2 Integer Column (1-20)
3 String Text to place into cell
 

mlsPutCellTag   back to top

Purpose: This command is used to tag a cell. Return: None Arg. Type Purpose
1 Integer Task Row (1 based)
2 Integer Column (1-20)
3 String Text with which cell is to be tagged.l  
 

mlsRefresh   back to top

Purpose:This command is used refresh the Milestones screen. Return: none Arguments: None  

mlsRefreshTask   back to top

Purpose:This command is used refresh the task line given in argument 1. Returns: None Arg. Type Purpose
1 Integer Task to refresh (1 based)
 

mlsResetEscapeKey   back to top

Purpose: This command is used to set the value for the Escape key back to "False"

Returns: None Arguments: None  



mlsRollUpTaskLines   back to top

Purpose:This command is used roll up all tasks to a specified level. Returns: None Arg. Type Purpose
1 Integer The level (1-9) to which you want all task lines rolled up
 

mlsSave   back to top

Purpose: This command is used to save a schedule to disk. Returns: String; the handle of the file to which the schedule was saved. If this handle is 0, then the save did not complete. Arg. Type Purpose
1 String Complete name of file, including the drive or share name, path, and .ml7 extension.
 

mlsSaveBitmap   back to top

Purpose: This command is used to save a bitmap to disk. Returns: None Arg. Type Purpose
1 String Complete name of file, including the drive or share name, path, and .jpg, .bmp, or .gif extension.
 

mlsSaveHTML   back to top

Purpose: This command is used to save an HTML file to disk. Returns: None Arg. Type Purpose
1 String Complete name of file, including the drive or share name, path, and .htm extension.
 

mlsSaveHTMLDrillDown   back to top

Purpose: This command is used to publish an entire set of schedules for the Internet. Starting with the current schedule, the software will publish any schedules which are Hyperlinked. Returns: None Arg. Type Purpose
1 String Complete name of the first file, including the drive or share name, path, and .htm extension.
 

mlsSelectSymbolInLine   back to top

Purpose: This command is used to cause a symbol to be selected in the GUI. Returns: None Arg. Type Purpose
1 Integer Task Line (1 based)
2 Integer Symbol to select (1 based)
 

mlsSetAutomationDependencyMode   back to top

Purpose: This command is used to turn dependency mode on or off. Returns: None Arg. Type Purpose
1 String "on" or "off"
 

mlsSetAutoSave   back to top

Purpose: This command is used to turn AutoSave off Returns: None   Arg. Type Purpose
1 String "on" or "off"
 

mlsSetCalculationColumnProperties   back to top

Purpose: This command is used to set up a Calculation / Indicator SmartColumn Returns: none Arg. Type Purpose
1 Integer Column (1-20)
2 String Property
    "Type" arg3 is 1,2,3,4 1-compare 2 columns, 2-value x %comp, 3-value x %not complete, 4-indicator only
    "Factor1" arg3 is 1-20 (not needed for type 4)
    "Factor2" arg3 is 1-20 (not needed for type 2,3,4)
    "Operator" arg3 is 0=mult, 1=add, 2=minus, 3=divide
    "DoNotCalculateOnSummaryLine" arg3 is 0 (false) or 1 (true)
    "ShowResultAsPercent" arg3 is 0 (false) or 1 (true)
   

"ShowSummaryValueAsAverage" arg3 is 0 (false) or 1 (true) - This setting only applies to Values... SmartColumns only.

   

"AddPercentSign" arg3 is 0 (false) or 1 (true)

   

"JustShowKeyedValueInSummaryLines" arg3 is 0 (false) or 1 (true) only has meaning for Values... column. This will cause the value entered or added via automation to be displayed instead of any value which might be calculated by the software.

   

   

Indicator settings

    "ColumnToCompare"          arg3 is 1-20
    "SymbolSize"               arg3 is 0.1 to 5.0 (double)
    "IndicatorAlign" arg3 is 0 (left) ,1 (center), 2 (right)
    "DisplayNumberAlso" arg3 is 0 (false) or 1 (true)
    "IndicatorType" arg3 is 0 (none), 1 (percent), 2 (value or text compare)
    "PercentIs0to1" arg3 is 0 (false - assume 0-100) or 1 (true - assume 0-1)
    "PercentSymbol" arg3 is 1-32
   

   

Up to 10 compare conditions

    "ConditionNSymbol" arg3 is 1-32.
    "ConditionNStatus" arg3 is 0 (ignore) or 1 (active)
    "ConditionNHighValue" arg3 is double
    "ConditionNCompareText" arg3 is string (any string here forces text compare and low/high value is ignored)
    "ConditionNLowValue" arg3 is double
    "ConditionNSymbolColor" arg3 is 0-18
    "ConditionNOverlayText" arg3 is string
 

mlsSetCalendarView   back to top

Purpose: This command is used to turn calendar view on/off Returns: None   Arg. Type Purpose
1 String "on" or "off"
2 Integer Taskline (0 for all)
 

mlsSetColumnProperty   back to top

Purpose: This command is used to set the properties of a column. Returns: none Arg. Type Purpose
1 Integer Column Number.
2 Variant "ColumnHeadingLine1" (Arg 3 is a string containing the column heading first line).
"ColumnHeadingLine2" (Arg 3 is a string containing the column heading second line).
"Hidden" (Arg 3 is "Yes" or "No")
"Indent" (Arg 3 is 0.0 to 5.0)
"FontStyle" (Style 1 to 7) See SetFontStyle for numbering scheme.
"FontSize" (Size 3 to 72)
"TextAlign" 0 to 2 (0=left, 1=centered, 2=right)
"SmartColumn"
 
"None"
"StartDate"
"EndDate"
"Duration"
"PercentComplete"
"TaskNumber"
"OutlineLevel"
"WBSNumber"
"StatusDate"
"UsedDuration"
"RemainingDuration"
"TimeAheadBehind"
"BaselineStart"
"BaselineEnd"
"BaselineDuration"
"ValueSet-1" to "ValueSet-9"
"Values"
"SymbolCount"
"Calculation"
 

mlsSetColumnWidth   back to top

Purpose: This command is used to set the width of a column. Returns: none Arg. Type Purpose
1 Integer Column Number.
2 Double Width of column.
 

mlsSetConnectorFillToStatus   back to top

Purpose: This command is used to turn on "Fill to Status" for horizontal connectors. Returns: None Arg. Type Purpose
1 String "On" or "Off"
 

mlsSetCurrentDate   back to top

Purpose: This command is used to set the current date of the active schedule. Returns: None Arg. Type Purpose
1 String New Current Date
 

mlsSetCurrentPage   back to top

Purpose: This command is used to move to a different page. Returns: None Arg. Type Purpose
1 Integer Page to display

 



mlsSetCurtainProperties   back to top

Purpose: This command is used to set the properties of the curtains. A curtain is used to shade a date range on the schedule. Returns: None Arg. Type Purpose
1 Integer Curtain number, 1 based (must already exist)
2 String Start Date/Time
3 String End Date/Time
4 Integer Curtain pattern color 1-18;
5 Integer Curtain background color 1-18
6 Integer Curtain pattern 1-27.
7 Integer Curtain border 1 or 0

 



mlsSetCustomColor   back to top

Purpose: This command is used to set the properties of the custom colors. Returns: None Arg. Type Purpose
1 Integer Color index (1-17)
2 Integer red 0-255
3 Integer green 0-255
4 Integer blue 0-255

 



mlsSetDataGraphProperty   back to top

Purpose: Set a property for a DataGraph Returns: Nones Arg. Type Purpose
1 integer DataGraph Number (1-3)
2 String "property to set"  
"ClearValueSets" arg 3 is unused but should be set to 0 (zero)
"Height" arg 3 is height
"LowY" arg 3 low Y axis value
"IncY" arg 3 Y axis increment
"HighY" arg 3 high Y axis value
"ShowGrid" arg 3 is "On" or "Off"
"LineType" arg 3 is 1-4
"ShowGraph" arg 3 "On" or "Off"
"LineBar" arg 3 is "Line" or "Bar" or "WideBar"
"PlotInScheduleArea" arg 3 "On" or "Off"
"BackgroundColor" arg 3 is 0-18
"GridColor" arg 3 is 0-18
"FadeType" arg 3 is 0-6
"IncludeValueSet" arg 3 is "ValueSet Name" or the ValueSet number (1-9)
3 Integer property value

 



mlsSetDateHeading   back to top

Purpose: This command is used to set the type of date heading. Even though the date heading types are set in the template file (see the .Template command) this allows you to set the headings to something different. For example, you might want to do this if you expand the schedule date range to the point where you want to switch from weekly to monthly headings. Returns: None Arg. Type Purpose
1 Integer Heading level (1 - 4)
2 String Type of heading from list below:  
"Yearly"
"Quarterly"
"Monthly"
"Weekly"
"Daily"
"Hourly"
"Minute"
"Custom"
"None"
3 Integer Sub-Heading. Argument 2 specifies the main type of heading, such as "Monthly" while argument 3 says what kind of monthly heading, such by names, by numbers, etc. See the date heading selection dialog box to see the sub-types for each type. For example, there are five different yearly heading choices from four-digit years, to numbered years, to fiscal years.

 



mlsSetDateHeadingProperty   back to top

Purpose: Set one of the four date headings properties Returns: None Arg. Type Purpose
1 Integer which heading 1-4
2   "HeadingBackGroundColor" arg 3 is 0-18
    "HeadingBackGroundColorTarget" arg 3 is 0-18
    "HeadingFadeType" arg 3 is 0-6
3   Property value. See above

 



mlsSetDebugMode   back to top

SetDebugMode "On" or "Off" Sets improved debug mode for automation. In this mode only debug messages for automation functions are displayed making the debugging much easier to follow.  

mlsSetDisplayedStartEndTimes   back to top

Purpose: This command is used to set the displayed start and end times. Return: None Arg. Type Purpose
1 Integer start hour
2 Integer start minute
3 Integer end hour
4 Integer end minute
 

mlsSetEndDate   back to top

Purpose: This command is used to set a new ending date for the schedule. Returns: None Arg. Type Purpose
1 String New End Date
 

mlsSetFontSize  back to top

Purpose: This command is used to set the current font size for the indicated schedule area. Return Value: none Arg. Type Purpose
1 Integer Area of schedule to set
  1. Column Text (set this before adding task lines)
  2. Symbol Text
  3. Title line 1
  4. Title line 2
  5. Title line 3
  6. Date heading 1
  7. Date heading 2
  8. Date heading 3
  9. Date heading 4
  10. Page number
  11. Current date
  12. Column heading 1
  13. Column heading 2
  14. Column heading 3
  15. Column heading 4
  16. Column heading 5
  17. Column heading 11
  18. Column heading 12
  19. Column heading 13
  20. Column heading 14
  21. Column heading 15
  22. Legend
  23. DataGraph
24-28=Column Head 6-10 on left 29-33=Column Head 16-20 on right NOTE: 10 additional columns were added in version 2002. That is why the numbering is not consecutive for the column headings.
2 Integer New size (3-72)
 

mlsSetFontStyle   back to top

Purpose: This command is used to set the current font size for the indicated schedule area. Return Value: none Arg. Type Purpose
1 Integer Area of schedule to set
  1. Column Text (set this before adding task lines)
  2. Symbol Text
  3. Title line 1
  4. Title line 2
  5. Title line 3
  6. Date heading 1
  7. Date heading 2
  8. Date heading 3
  9. Date heading 4
  10. Page number
  11. Current date
  12. Column heading 1
  13. Column heading 2
  14. Column heading 3
  15. Column heading 4
  16. Column heading 5
  17. Column heading 11
  18. Column heading 12
  19. Column heading 13
  20. Column heading 14
  21. Column heading 15
  22. Legend
  23. DataGraph
24-28=Column Head 6-10 on left 29-33=Column Head 16-20 on right NOTE: 10 additional columns were added in version 2002. That is why the numbering is not consecutive for the column headings.
2 Integer New style 0 = normal 1 = bold 2 = bold and italic 3 = bold and underlined and italic 4 = italic 5 = underlined and italic 6 = underlined and bold 7 = underlined
3 Integer Size (3-72) (Use -1 to ignore this option)
4 Integer Color 1-18
 

mlsSetFrameAndBackgroundOptions   back to top

Purpose: This command is used to set frame and background options. Returns: None Arg. Type Purpose
1 Integer Frame Thickness (0-3)
2 Integer Frame corner type (0=square, 1=rounded)
3 Integer Frame color.
4 Integer Background color.
5 Integer Effects target color.
6 Integer Effects type (0-6) (See dialog box)
7 Integer Include background color on prints and metafiles (0=no, 1=yes)
8 Integer Fill interior only (0=no, 1=yes)
 

mlsSetFreeTextProperty   back to top

Purpose: This command is used to set the properties of a freeform text item. Return: None Arg. Type Purpose
1 Integer Text block index, 1 based
2 Integer Property Property Argument 3 "XPos" double xpos in inches "YPos" double ypos in inches "Page" int page number (1 based) "Border" int (0-no border, 1-border) "Transparent" int (0-not transparent, 1-transparent) "Shadow" int (0=no shadow, 1=shadow) "BackGroundColor" int 0 to 18 "ShadowColor" int 0 to 18 "BackgroundColorTarget" int 0 to 18 "FadeType" int 0 to 6 "TextColor" int 0 to 18 "TextHeight" int 3 to 72 "UnderLine" int 0 or 1 "Bold" int 0 or 1 "Italic" int 0 or 1 "TextAlign" arg 3 is int 0 (left) 1 (center) or 2 (right) "TagInfo" arg 3 is text (1 to 39 bytes) "FontName" arg 3 is text (1 to 59 bytes) "Text" arg 3 is text (1 to 1998 bytes)
 

mlsSetGlobalSymbolSize   back to top

Purpose: This command is used to set the relative symbol size to be used by all symbols, except those overridden individually via SetSymbolProperty. Returns: None Arg. Type Purpose
1 Real Symbol size from .1 to 5.0
 

mlsSetGlobalValueSetValue   back to top

Purpose: This command is used to set the valueset value. Returns: None Arg. Type Purpose
1 String ValueSet Name
2 String ValueSet Date
3 Double New Value
 

mlsSetHideBaseLineSummaryBar   back to top

Purpose: This command turns on/off the hiding of the baseline summary bar. Return Value: None Arg. Type Purpose
1 String "On" or "Off".
 

mlsSetHolidayCalendar   back to top

Purpose: Sets the internal-to-schedule holiday calendar Arg. Type Purpose
1 String "RESET" or "ADD"
2 String Date (if arg 1 == add) not needed if arg 1=RESET
 

mlsSetInternetPublishingOptions   back to top

Purpose: Used to set the Internet options prior to using the SaveHTML or SaveHTMLDrillDown methods. Returns: None Arg. Type Purpose
1 Integer The HTML Background color (0-274) same order as in the Internet Publishing Wizard's drop down box. Default is 2 (a light gray)
2 String Alternate title (string up to 199 characters)-is a permanent change since value is written to registry. Reset using a 0 length string "".
3 Integer Include bitmap with HTML (0=no, 1=yes)
4 Integer Include HyperLinks in HTML (0=no, 1=yes)
5 Integer Create one bitmap per page (0=no (just the first page), 1=yes, all pages)
6 Integer Create HyperLink image map (0=no, 1=yes)
7 String Starter for generated bitmaps. r (string up to 9 characters)-Reset using a 0 length string ""
8 Integer JPEG compression (10-100) Default is 70.
9 Integer Bitmap format to use. (0=bmp, 1=jpg, 2=gif) (note that optional gif export filter must be installed for gif to work)
10 Integer Exclude symbols from HTML (0=no, 1=yes)
11 Integer Exclude table from HTML (0=no, 1=yes)
12 Integer Exclude file name from HTML (0=no, 1=yes)
13 Integer Exclude project dates from HTML (0=no, 1=yes)
14 Double Image scale factor (0.1-6.0) floating point value - usual default is 0.75
15 Integer Create drill down for all HyperLinked Pages (0=no, first page only, 1=yes, all pages)
16 Integer Create all symbol HyperLinked HTML Pages for Main Schedule Only (0=no, 1=yes)
 

mlsSetLegendHeight   back to top

Purpose: This command is used to set the height of the legend Returns: none Arg. Type Purpose
1 Double Height of the legend.
 

mlsSetLegendProperty   back to top

Purpose: Set a property for a Legend. Returns: None Arg. Type Purpose
1 integer Legend Property
Property Parameter 2
   
"EntriesPerRow" The # of entries
"Frame" 0=no frame, 1=frame
"SymbolSize" A symbol size from 0.1 to 5.0
"Gap" 0 or 1 where 0 means no gap
"Color" A background color from 0 to 18
   
2 Variant Value of Property - see table above
 

mlsSetLegendSymbology   back to top

Purpose:This command is used to set the symbology for the legend. Returns: None Arg. Type Purpose
1 Integer Index of legend entry to be set (1-30)
2 Integer Symbol 1 index from the toolbox.
3 Integer Connector index from the toolbox.
4 Integer Symbol 2 index from the toolbox.
 

mlsSetLegendText   back to top

Purpose:This command is used to set the text for existing legend entries on a schedule Returns: None Arg. Type Purpose
1 Integer Index of legend entry to be set (1-30)
2 String Text for line one of this legend entry
3 String Text for line two of this legend entry
 

mlsSetLinesPerPage   back to top

Purpose: This command is used to set the lines per page. Returns: none Arg. Type Purpose
1 Integer New lines per page value
 

mlsSetMiscProperty   back to top

Purpose: This command is used to set the properties of a column. Returns: none Arg. Type Purpose
1 String Property to set "ShowPageNumber" (Arg 2 is 0-1).
"ShowCurrentDate" (Arg 2 is 0-1).
"ShowCurrentDateLine" (Arg 2 is 0-1).
"UseEarnedValueMethodForPercentOnSummaryLines" (Arg 2 is 0-1).
"HourlyDetail" (Arg 2 is 0-1).
"MinuteDetail" (Arg 2 is 0-1).
"ShowDurationAndPercentDecimal" (Arg 2 is 0-1).
2 Integer Value to set property
 

mlsSetOutlineLevel   back to top

Purpose: This command is used to set the current outline level of the task row. Returns: None Arg. Type Purpose
1 Integer Task Row (1 based)
2 Integer New outline level (1-9)
 

mlsSetOutlineLevelAttribute   back to top

Purpose: Set an attribute for an outline level Returns: None Arg. Type Purpose
1 Integer Outline Level (1-20)
2 String "Property to set"
 
"Fontsize" arg 3 is 3-72
"Bold" arg 3 is 0-1
"BoldItalic" arg 3 is 0-1
"Italic" arg 3 is 0-1
"Underline" arg 3 is 0-1
"Color" arg 3 is 0-18
3 Integer property value

 



mlsSetPageSize   back to top

Purpose: This command is used to set the dimensions of the page. Returns: none Arg. Type Purpose
1 Double Page width
2 Double Page height
 

mlsSetPageStartEndDates   back to top

Purpose: This command is used to set the start and end dates for an individual page. Returns: None Arg. Type Purpose
1 Integer Page Number (1 based)
2 String Start Date ("mm/dd/yy" format)
3 String End Date ("mm/dd/yy" format)
 

mlsSetPercentComplete   back to top

Purpose: This command is used to set the percent complete for the current row. It will use the status symbol method. If no status symbol is on the row, it will insert one. If a status symbol is not defined in the toolbox, it will use symbol 32 and reset it to an invisible status symbol. Returns: None Arg. Type Purpose
1 Integer Task Row
2 Real Percentage Complete for row 0.0 to 100.0
 

mlsSetScheduleGridlinesAndShades   back to top

Purpose: This command is used to set the task shading for a schedule. Returns: None Arg. Type Purpose
1 Integer 0,1,2 (0=left, 1=schedule, 2=right)
2 Integer line color index (-1 to 18) (-1 means no grid lines regardless of other parameters)
3 Integer line pattern (0 to 3)
4 Integer shade color (-1 to 18) (-1 means no grid shading regardless of other parameters)
5 Integer shade target color (0 to 18)
6 Integer fade type (0 to 6)
7 Integer alternating lines for grids and shades (0 to 2) 0=all lines, 1=odd lines, 2=even lines
 

mlsSetShowLinks   back to top

Purpose: Turns task links on or off. Task links are the vertical links which go from a symbol on one row to another. This also turns dependency mode on when task links are on and off when task links are off. Returns: None Arg. Type Purpose
1 String "On" or "Off"
 

mlsSetStartDate   back to top

Purpose: This command is used to set a new starting date for the schedule. Returns: none Arg. Type Purpose
1 String New Starting date for schedule.
 

mlsSetStartAndEndDates   back to top

Purpose: Use this method to set the start and end dates at once. Returns: None Arg. Type Purpose
1 String Start date for the schedule
2 String End date for the schedule
 

mlsSetStatusMessage   back to top

Purpose: This command is used to display a message in the Milestones Status Bar. Returns: None Arg. Type Purpose
1 String Message to display (1 to 39 characters)
 

mlsSetSummaryBarDisplay   back to top

Purpose: This command is used to set the options for when to display summary bars Return Value: None Arg. Type Purpose
1 Integer 0=never show summary bars, 1=only show summary bars when rolled up 2=always show summary bars
 

mlsSetSymbolDateFormat   back to top

Purpose: This command is used to set the date format for the symbols. Return Value: None Arg. Type Purpose
1 String 0= Minute only1= Hour and Minute, 24 Hour format 2= Hour and Minute, 12 Hour format 3= Hour only 4= Day only 5= Month and Day 6= Year, Month, and Day 7= Year and Month 8= Month only 9= Day from start of schedule 10= Minute from start of schedule 11= Minute from start of schedule shown as mm.mm 12= Year only 13= Month from start of schedule 14= Hour from start of schedule
2 No 0= Do not append AM/PM if using type 21= Append AM/PM if using type 2
3 No 0= Do not show leading zeros in month and day 1= Show leading zeros in month and day
4 No Starting value to be used in ... from start formats (9,10,11,13,14)
 

mlsSetSymbolFillToStatus   back to top

Purpose: This command is used to turn on "Fill to Status" for symbols. Returns: None Arg. Type Purpose
1 String "On" or "Off"
 

mlsSetSymbolProperty   back to top

Purpose: This command is used to set the various properties of an existing symbol. Returns: None Arg. Type Purpose
1 Integer Task Row (1 based)
2 Integer Symbol Number (1 based)
3 String Desired Property from list below:
Argument 3   Argument 4
"Connector1Color"   Override color for the first horizontal connector originating from this symbol.
"Connector2Color"   Override color for the second horizontal connector originating from this symbol.
"Date"   m/d/y in short date format as defined by your regional settings in the Windows Control Panel.
"DateBack"   "opaque" or "transparent" for the symbol date background.
"SymbolType"   is 1-32, identifying the symbol in the toolbox.
"HorizontalConnectorType"   type of horizontal connector from toolbox (1-16). Sub-Property is 1 or 2 for 1st or 2nd connector. First connector assumed if no Sub-Property.
"HorizontalConnection"   index which indicates which symbol (on the task line) to use.If this symbol will connect to the 3rd symbol on this task line, set it to 3. Set to 0 if not used. Up to two horizontal connectors can originate from any symbol. Sub-Property is 1 or 2 for 1st or 2nd connector. First connector assumed if no Sub-Property.
"VerticalConnectorType"   type of vertical connector from toolbox (1-8). Sub-Property is 1 - 5 for 1st - 5th connector. First connector assumed if no Sub-Property.
"VerticalConnectionLineIndex"   index to connected line (1 based) or 0 if not used). Sub-Property is 1 - 5 for 1st - 5th connector. First connector assumed if no Sub-Property.
  "VerticalConnectionSymbolIndex"   index to connected symbol on connected line (1 based) or 0 if not used. Sub-Property is 1 - 5 for 1st - 5th connector. First connector assumed if no Sub-Property.
"SymbolColor"   Color.
"SymbolHour"   (0-23), the hour that the symbol has been placed at
"SymbolMinute"   (0-59), the minute that the symbol has been placed at.
"SymbolText"   the requested line of symbol text. Sub-Property is 1 - 3 for 1st - 3rd symbol text line. Sub-Property is required for this property.
 "SymbolNotes"   the symbol note string associated with the symbol if any
"SymbolSize"   Arg 4 is a value from 0.1 to 5.0 which is used to override the symbol size.
"SymbolTextPosition   Arg 4 is the symbol text position. It is a value from 1 to 13.
"SymbolDatePosition"   Arg 4 is the symbol text position. It is a value from 1 to 13.
"RollUpToSummaryBar"   Arg 4 is "On" or "Off"
"ValueSetValue"   Arg 4 is ValueSetNumber(1-9) Arg 5 is the value
"VerticalLevel"   Arg 4 is the override vertical level for symbol (-1=toolbox setting, 0=middle, 1=upper, 2=lower)
"SymbolHyperlink"   Arg 4 is a file name or web URL string
"TextBack"   Arg 4 is a "Transparent" or "Opaque" for the symbol text background.
4 String or Integer New value of the property. Use a String for text based properties and an Integer for number based properties. Dates are passed in as Strings.
5 Integer Sub-Property. Only used for properties that require a Sub-Property.
 

mlsSetTaskLineFontHeight    back to top

Purpose: This command is used to set the font size for an individual task Returns: None Arg. Type Purpose
1 Integer Task Number
2 Integer Font size (4 to 72)
 

mlsSetTaskLineFontStyle    back to top

Purpose: This command is used to set the font style for an individual task Returns: none Note: Set the default font (Arial, Tms Roman, etc.) in the template that you are using. Arg. Type Purpose
1 Integer Task Number
2 Integer 0 = normal 1 = bold 2 = bold and italic 3 = bold and underlined and italic 4 = italic 5 = underlined and italic 6 = underlined and bolc 7 = underlined
 

mlsSetTaskLineGrid   back to top

Purpose: This command is used to set the grid line for an individual task. Returns: None Arg. Type Purpose
1 Integer Task Number
2 Integer 0,1,2 (0=left, 1=schedule, 2=right)
3 Integer Color.
4 Integer GridType. 0=solid line, 1=dotted line, 2=dashed line, 3=thick line A value of -1 will reset the value to the default.
 

mlsSetTaskLineHeight   back to top

Purpose: This command is used to set the text for existing legend entries on a schedule Returns: None Arg. Type Purpose
1 Integer Task Line being adjusted
2 Double Height of task line (0.1 to 8.0)
 

mlsSetTaskLineShade   back to top

Purpose: This command is used to set the shading for an individual task. Returns: None Arg. Type Purpose
1 Integer Task Number
2 Integer Section of the schedule: 0,1,2 (0=left, 1=schedule, 2=right)
3 Integer Color. A value of -1 will reset the color to the default.
 

mlsSetTaskLineShadeEffects   back to top

Purpose: This command is used to set shade effects for task line Returns: none Arg. Type Purpose
1 Integer Task Number
2 Integer

0,1,2 (0=left, 1=schedule, 2=right)

3 Integer

Target color

4 Integer

effect type (0-6) A value of -1 will reset the fade type to the default.

 

mlsSetTasklineValueSetValue   back to top

Purpose: Sets the value for a task line ValueSet Returns: None Arg. Type Purpose
1 Integer Task Number
2 String ValueSet Name
3 String Date
4 Double New ValueSet Value
 

mlsSetTitle1   back to top

Purpose: This command is used to set the first line of the chart title. Returns: None Arg. Type Purpose
1 String Sets the first line of the title
 

mlsSetTitle2   back to top

Purpose: This command is used to set the second line of the chart title. Returns: None Arg. Type Purpose
1 String Sets the second line of the title
 

mlsSetTitle3   back to top

Purpose: This command is used to set the third line of the chart title. Returns: None Arg. Type Purpose
1 String Sets the third line of the title
 

mlsSetTitleProperty   back to top

Purpose: This command is used to set the chart title properties Returns: None Arg. Type Purpose
1 String "Line1TextColor" arg 2 is 0-18. arg 2 is 0-18. arg 2 is 0=left, 1=center, 2=right arg 2 is 0=no, 1=yes arg 2 is 0=no, 1=yes arg 2 is 0=no, 1=yes arg 2 is 0-18.   arg 2 is 0-18.   arg 2 is 0-18.   arg 2 is 0-6. arg 2 is 0=none, 1=engrave, 2=emboss, 3=shadow arg 2 is 0=no, 1=yes
arg 2 is 0-18.  
"Line2TextColor"
"Line3TextColor"
"Align"
"ShowBorder"
"ShowShadow"
"FullWidthBackground"
"BackgroundColor"
"TargetColor"
"ShadowColor"
"FadeType"
"Highlight"
"ExtraSpaceBelow"
2 String New value for property
 

mlsSetToolboxHorizontalConnectorProperty   back to top

Purpose: This command is used to change properties of the toolbox horizontal connectors. Returns: none Arg. Type Purpose
1 Integer Connector number in toolbox (1 based) 1-16.
2 String Property to set
     
"AfterStatusFillColor" Arg 3 is 1-18. .
"AfterStatusFillColorTarget" Arg 3 is 1-18. .
"FadeType" Arg 3 is 0-6.
"Fill Color" Arg 3 is 1-18.
"FillColorTarget" Arg 3 is 1-18.
"Fill Pattern" Arg 3 is 1-27.
"LinePattern" Arg 3 is 1-4. See
"OutlineColor" Arg 3 is 1-18. See
"ShowShadow" Position of the symbol date. Arg 3 is the position.
"ShadowColor" Arg 3 is 1-18.
"ShadowSize" Arg 3 is 1=small, 2=medium 3=large
"Type" Arg 3 is 1-35.
3 Integer See above
 

mlsSetToolboxProperty   back to top

Purpose: This command is used to set toolbox properties. Returns: None Arg. Type Purpose
1 String Property to Set "Combo" "Standard" Arg 2 is 1-8 for number of symbol rows Arg 2 is 1-8. Arg 2 is 1-8 Arg 2 is 0-2 Arg 2 is 0 or 1 for off/on
Arg 2 is 1-16 for the number of rows
"ConnectorRows"
"SymbolRows"
"VertConnectorRows"
"ShowDrawingTools"
2 Integer New value of property
 

mlsSetToolboxSymbolProperty   back to top

Purpose: This command is used to change properties of the toolbox symbols. Returns: None Arg. Type Purpose
1 Integer Symbol number in toolbox (1 based) 1-32.
2 String Property to set
     
"TextBack" Background for the symbol text. Arg 3 is "Transparent" or "Opaque"
"DateBack" Background for the symbol date. Arg 3 is "Transparent" or "Opaque"
"Type" Symbol shape. Arg 3 is 1-96.
"TextPosition" Position of the symbol text. Arg 3 is the position.
"DatePosition" Position of the symbol date. Arg 3 is the position.
"Special" Arg 3 is "Status" or "Comment" or "Baseline"
"LetterMark" Arg 3 is "M", where M is the letter marking (use any letter or number).
"FillColor" Arg 3 is 1-18.
"FillColorAfterStatus" Arg 3 is 1-18.
"OutlineColor" Arg 3 is 1-18.
"ShowShadow" Arg 3 is "On" or "Off"
"ShadowColor" Arg 3 is 1-18.
"ShadowSize" Arg 3 is 1=small 2=medium 3=large
"VerticalLevel" Arg 3 is 0 to 2 (0=top, 1=middle, 2=below)
3 String New value of property
 

mlsSetToolboxVerticalConnectorProperty   back to top

Purpose: Set a specific property of a vertical connector in the toolbox Returns: None Arg. Type Purpose
1 Integer Vertical Connector number in toolbox (1 based) 1-8
2 String Property to set
3   "Type" Arg 3 is 1-15. Arg 3 is 1-4 Arg 3 is 1-18 Arg 3 is 0-2 0=normal, 1=small, 2=large
"LinePattern"
"Color"
"ArrowheadSize"
"RoundedCorners" Arg 3 is 'On' or 'Off' (applies to all vertical connectors, so arg 1 is not used but must be valid)
 

mlsSetValueSetDateAlignment   back to top

Purpose: Sets the alignment of ValueSets on this schedule Returns: None Arg. Type Purpose
1 String "Daily", "Weekly", "Monthly" or "Yearly"
 

mlsSetValueSetName   back to top

Purpose: Sets the name of a ValueSet Returns: None Arg. Type Purpose
1 Integer The index (1-9) of the ValueSet
2 String The new ValueSet name
 

mlsSetValueSetProperty   back to top

Purpose: Sets properties for an existing, named ValueSet Returns: None Arg. Type Purpose
1 String The name or number (1-9) of the ValueSet
2 String Property to set.  
"Type" arg 3 is 1-5  
 "LineType" arg 3 is 1-4
"BarPattern" arg 3 is 1-4
"NumberDecimals" arg 3 is 0-6
"LineColor" arg 3 is 0-18 (use this option for both line and bar graphs)
"FillColorTarget" arg 3 is 0-18
"FadeType" arg 3 is 0-6
"IncludeInSummary" arg 3 "ValueSet to Include" - takes one call for each valueset to add
"Show"
arg 3 is "NumericOn"
arg 3 is "NumericOff"
arg 3 is "GraphOn"
arg 3 is "GraphOff"
arg 3 is "NumericCumulativeOn"
arg 3 is "NumericCumulativeOff"
arg 3 is "GraphCumulativeOn"
arg 3 is "GraphCumulativeOff"
arg 3 is "CurrencyOn"
arg 3 is "CurrencyOff"
arg 3 is "IgnoreZeroesOn"
arg 3 is "IgnoreZeroesOff"
arg 3 is "UnderTasklinesOn"
arg 3 is "UnderTasklinesOff"
arg 3 is "NameInTasklinesOn"
arg 3 is "NameInTasklinesOff"
arg 3 is "LeadingZeroesOn"
arg 3 is "LeadingZeroesOff"
"Type3Column" arg 3 is column 1-20
"Type3AllocateValuesBeforeCurrentDate" arg 3 is "Yes" or "No"
"Type3AllocateValuesAfterCurrentDate" arg 3 is "Yes" or "No"
"Type4IgnoreValuesAfterStatusDate" arg 3 is "Yes" or "No"
"Type4IgnoreValuesOutsideScheduleStartEnd" arg 3 is "Yes" or "No"
3 Variant The new value (documented above along with each possible argument 2.
 

mlsSetWorkdayStartEndTimes   back to top

Purpose: This command is used to set the workday start and end times. Return: None Arg. Type Purpose
1 Integer start hour 1
2 Integer start minute 1
3 Integer end hour 1
4 Integer end minute 1
5 Integer start hour 2
6 Integer start minute 2
7 Integer end hour 2
8 Integer end minute 2
 

mlsShowAllTaskLines   back to top

Purpose: This command is used to show all task lines. Returns: none Arguments: none  

mlsSortSymbols   back to top

Purpose: This command is used to sort the symbols on a row to make sure that they are in the correct date order. Return Value: None Arg. Type Purpose
1 Integer Task row to sort.
 

mlsTemplate   back to top

Purpose: This command loads and applies a template file to the schedule. Returns: none Arg. Type Purpose
1 String Name of template file to load.
 

mlsToggleContinuousView   back to top Purpose: This command lets the programmer take advantage of 20 columns, 10 of which were added in Milestones Professional 2002. Returns: none Arguments: none  

mlsToolbar   back to top

Purpose: This command turns the Milestones Toolbar on or off. Returns: None Arg. Type Purpose
1 String "on" or "off"
 

mlsToolbox   back to top

Purpose: This command turns the Milestones Toolbox on or off. Returns: None Arg. Type Purpose
1 String "On" or "Off"
 

mlsUse20Columns   back to top

Purpose: This command lets the programmer take advantage of 20 columns, 10 of which were added in Milestones Professional 2002. Returns: none Arguments: none