GetSymbolProperty

Purpose: Returns information about a specified symbol on the current schedule.

Returns: Variant, The requested symbol property. This is usually an Integer (within a Variant), but the date, symbol text, and symbol note properties are returned as strings (within a Variant).

Argument

Type

Required

Purpose

Integer

Yes

Task Row (1 based)

Integer

Yes

Symbol Number (1 based)

String

Yes

Desired Property from list below:

"Color"	returns (1-19), current color index of the assigned symbol fill color. See About Color numbering and RGB Color
"Date"	returns m/d/y in short date format as defined by the 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-32) or 0 if no connector. 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.
"SymbolName"	returns symbol name
"LinkedToSymbolName"	returns symbol name of symbol this symbol links to
"LinkedToFilelName"	returns file name of file containing symbol that this symbol links to
"Percent1Override"	Each symbol can have 2 horizontal connections. Each connection can have a % override. (Typically symbols have only 1 % override). This property can be used to set the % complete for the symbol and 1st bar. Argument 4 is the % (0-100). Use -1 to set to "none"
"Percent2Override"	This property can be used to set the % complete for the symbol and 2nd bar. (See Percent1Override) Argument 4 is the % (0-100) Use -1 to set to "none"
"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
"SymbolTag"	returns the tag associated with the symbol.
"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-64. Click here to read about how the symbols are numbered.
"TextBack"	returns "Transparent" or "Opaque"
"ValueSetValue"	returns value or 0.0, Arg 4 is 1-9, indicating which ValueSetA group of numerical values associated with either a time period, a time period and task, a symbol, a column's values, or a sum of other ValueSets. Values from ValueSets can be graphed in one or more of the schedule's DataGraphs..
"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). Click here to read about vertical connector numbering. Sub-Property is 1 - 5 for 1st - 5th connector. First connector assumed if no Sub-Property.

Sub-Property

See above

Notes:

The task rowA horizontal row on the schedule, usually containing the name of a project step and important milestone dates for that step. and symbol must exist or an error is generated. Argument 4 is optional except for the SymbolText property. Empty symbol text lines usually get eliminated. For example, to add a symbol and only assign text to symbol text line 3, it would get moved up to line 1. To prevent this, assign several blank characters to a symbol text line to force the line after it to remain in place.