SetSymbolProperty

Example - SetSymbolProperty

Example - Symbol Notes

Purpose: Set the various properties of an existing symbol.

Returns: none

Argument  

Type

Required

Purpose

1

Integer

Yes

Task Row (1 based)

2

Integer

Yes

Symbol Number (1 based)

3

String

Yes

Desired Property from list below:

Argument 3

 

Argument 4

"Connector1Color"

 

Override color for the first horizontal connector originating from this symbol.  See About Color numbering and RGB Color

"Connector2Color"

 

Override color for the second horizontal connector originating from this symbol. See About Color numbering and RGB Color

"Constraint"

 

Constraint date (in short date format as defined by the regional settings in the Windows Control Panel.)

Arg 5 is Constraint type

0: none

1: must be on this date

2: no later than

3: no earlier than

4: lock to this date

5: reminder, action

"CustomDateFormat"

 

Argument 4 is a custom date format

"Date"

 

Argument 4 is the date using the m/d/y in short date format as defined by the regional settings in the Windows Control Panel.

"DateBack"

 

Argument 4 is "opaque" or "transparent" for the symbol date background.

"DatePrefix"

 

Argument 4 is a string of text which will precede the symbol date.

"DateSuffix"

 

Argument 4 is a string of text which will follow the symbol date.

“DrawTextAtAngle”

 

For argument 4:

0: reset text and date angle to 0

1: show text only at angle

2: show both text and date at angle

"FillColorColumnTag"

 

Enables the tag of the column that contains color overrides to be specified.  The tag can be up to 79 characters long.  Example: .SetSymbolProperty 5,1, "FillColorColumnTag", "Text22"  See also

"Highlight"

 

For argument 4:

0: no forced highlight

1: forced highlight

"HorizontalConnectorType"

 

Argument 4 is the type of horizontal connector from toolbox (1-32). Click here to read about horizontal connector numbering.

Sub-Property is 1 or 2 for 1st or 2nd connector. First connector assumed if no Sub-Property.   see About Color numbering and RGB Color

"HorizontalConnection"

 

Argument 4 is the 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.

"IgnoreFilltoStatusforOverrideColor"

 

Allows the symbol to be set to ignore fill-to-status if an override fill color has been specified.  This is equivalent to checking the "Also override after status color" in the enhanced toolbar size/color settings tab for the selected symbol.

Arg. 4 can be 0 or 1

"LinkedToFileName"

 

Argument 4 is either the name of the file to which the symbol is being linked or the following text if the symbol is in the current file: "A symbol in this file"  Example

"LinkedToSymbolName"

 

Argument 4 is name of the symbol to which the specified symbol is being linked.  The symbol name may have up to 29 characters. Example

"MarkingOverlay"

 

Valid values of 0-20 map to the 21 options available in the Marking dropdown in the Symbol Options dialog. The 0 value means no marking as this is the default.

"Percent1Override"

 

Override the percent complete for the first bar which originates from this symbol.

Argument 4 is the percent (-1 to 100)  -1 means reset, 0 to 100 is percent to use.

"Percent2Override"

 

Override the percent complete for the second bar which originates from this symbol.

Argument 4 is the percent (-1 to 100)  -1 means reset, 0 to 100 is percent to use.

"RollUpToSummaryBar"

 

Argument 4 is either:

"On" : this symbol will be displayed on the summary bar

"Off": this symbol will not be displayed on the summary bar.

"SymbolColor"

 

Argument 4 is the symbol fill color. see About Color numbering and RGB Color

"SymbolDatePosition"

 

The symbol date position.  Argument 4 is a value from 1 to 13. Click here for more.

"SymbolHour"

 

Argument 4 is (0-23), the hour that the symbol has been placed at

"SymbolHyperlink"

 

Argument 4 is a file name or web URL string

"SymbolLineColor"

 

Argument 4 is the color of the symbol outline. See About Color numbering and RGB Color

"SymbolMarkType"

 

Argument 4 is the symbol mark (0-20)  0 means no symbol mark. See symbol marks.

"SymbolMarkColor"

 

Argument 4 is the color. see About Color numbering and RGB Color

"SymbolMinute"

 

Argument 4 the minute that the symbol has been placed (0-59).

"SymbolName"

 

Argument 4 is the name being assigned as the symbol name for the specified symbol.  Name a symbol if the program will use the "LinktoFileName" and "LinkToSymbolName" properties. Example

"SymbolNotes"

 

Argument 4 is the symbol note string associated with the symbol if any.  Example

"SymbolNoteFont"

 

Argument 4 is the font to use for the note. Limit of 79 characters

"SymbolNoteFontColor"

 

Argument 4 is the  RGB value of the note text color

"SymbolNoteBackgroundColor"

 

Argument 4 is the RGB value of the note background color

"SymbolNoteBackgroundColorTarget"

 

Argument 4 is the RGB value of the note background target color

"SymbolNoteFrameColor"

 

Argument 4 is the RGB value of the note frame color

"SymbolNoteShadowColor"

 

Argument 4 is the  RGB value of the note shadow color

"SymbolNoteConnectorColor"

 

Argument 4 is the  RGB value of the note connector color

"SymbolNoteDisplay"

 

Argument 4 is:

0: do not display note

1: display note

"SymbolNoteFrameDisplay"

 

Argument 4 is:

0: do not display frame

1 to 3: frame thickness

"SymbolNoteShadowDisplay"

 

Argument 4 is:

0: do not display note shadow

1: display note shadow

"SymbolNoteConnectCenter"

 

Argument 4 is:

0: do not connect to center

1: connect to center of note

"SymbolNoteSpecialEffects"

 

Argument 4 is:

0: none (solid background)

1: Fade to Bottom

2: Fade to Top

3: Fade to Center (V)

4: Fade to Right

5: Fade to Left

6: Fade to Center (H)

7: Fade to Upper Center (V)

8: Fade to Edge

9: No Background

"SymbolNoteConnectorType"

 

Argument 4 is 0 to whatever last entry is in GUI for this. As of this writing, there are 15 possibilities, starting at 0 for “None” and ending at 14.

"SymbolNoteFontSize"

 

Argument 4 is the size in points. It should be one of the sizes available in the dropdown box in the GUI. Values outside this range have unpredicatable results.

"SymbolNoteFontJustification"

 

Argument 4 is 0 (for left), 1 (for center), or 2 (for right).

"SymbolNoteFontBold"

 

Argument 4 is 0 (for not bold), or 1 (for bold).

"SymbolNoteFontItalic"

 

Argument 4 is 0 (for not italic), or 1 (for italic).

"SymbolNoteFontUnderline"

 

Argument 4 is 0 (for not underline), or 1 (for underline).

"SymbolNoteXOffset"

 

Argument 4 is -50 to +50. This represents the relative location to the right or left of the symbol in terms of global symbol width. 0 is directly over the symbol (but offset to the right somewhat)

"SymbolNoteYOffset"

 

Argument 4 is -50 to +50. This represents the relative location above or below the symbol in terms of global symbol height. 0 is directly over the symbol.

   
  • Note that SymbolNoteXoffset and SymbolNoteYOffset are always relative to global symbol size. Changing the global symbol size in the Format menu will move all the displayed notes closer or further away from the symbols. The connector ends will also increase in size relative to the global symbol size.  

"SymbolSize"

 

Argument 4 is a value from 0.1 to 5.0 which is used to override the symbol size.  

"SymbolTag"

 

sets the automation tag (string) associated with the symbol.

"SymbolText"

 

Argument 4 the requested line of symbol text. Sub-Property is 1 - 3 for 1st - 3rd symbol text line. Sub-Property is required for this property.

"SymbolTextColor"

 

Argument 4 is Color. see About Color numbering and RGB Color

"SymbolTextPosition

 

Argument 4 is the symbol text position. It is a value from 1 to 13. Click here for more.

"SymbolType"

 

Argument 4 is 1-64, identifying the symbol in the toolbox. Click here to read about symbol numbering.

"TextBack"

 

Argument 4 is a "Transparent" or "Opaque" for the symbol text background.

"TextLine1BoldItal"

 

Argument 4 is the attribute: 0=default, 1=bold, 2=italic, 3=bold/italic

"TextLine3BoldItal"

 

Argument 4 is the attribute: 0=default, 1=bold, 2=italic, 3=bold/italic

"TextLine3BoldItal"

 

Argument 4 is the attribute: 0=default, 1=bold, 2=italic, 3=bold/italic

"TextLine1Color"

 

Argument 4 is Color. see About Color numbering and RGB Color   (Must be RGB Color)

"TextLine2Color"

 

Argument 4 is Color. see About Color numbering and RGB Color   (Must be RGB Color)

"TextLine3Color"

 

Argument 4 is Color. see About Color numbering and RGB Color   (Must be RGB Color)

"TextSize"

 

Argument 4 is the size of the text, 3 to 72

"ValueSetValue"

 

Argument 4 is ValueSetNumber(1-9)

Argument 5 is the value

"VerticalConnectionLineIndex"

 

Argument 4 is the 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.

"VerticalConnectorLineColorOverride"

 

Argument 4 is the color. See About Color numbering and RGB Color  Sub-Property is 1 - 5 for 1st - 5th connector. First connector assumed if no Sub-Property.

"VerticalConnectorLinePatternOverride"

 

Argument 4 is the Vertical connector line pattern.  Sub-Property is 1 - 5 for 1st - 5th connector. First connector assumed if no Sub-Property.

"VerticalConnectionSymbolIndex"

 

Argument 4 is the 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"

 

Argument 4 is the type of vertical connector from toolbox (1-8).

Click here to read about vertical connector numbering.

Sub-Property is 1 - 5 for 1st - 5th connector. First connector assumed if no Sub-Property.

"VerticalConnectorTypeOverride"

 

Argument 4 is new connector type 0-8.  0 means reset override.  Arg. 5 is 1-5

Click here to read about vertical connector numbering.

"VerticalLevel"

 

Argument 4 is the Vertical Level

4

String or Integer

Yes

 

5

Integer

No

 

 

 Notes:

 

 

Milestones Professional 2019 Automation Methods and Properties.  © Copyright 2018, KIDASA Software, Inc. All rights reserved.