KIDASA Software, Inc. Website   

HOME   |   BUY   |   DOWNLOAD   |  PRODUCTS   |    NEWS   |   SUPPORT   |   CONTACT   |   EXAMPLES   |   SEARCH

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 
 
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

1

String

Curtain starting date and time

2

 String

Curtain ending date and time

 

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