ISReferenceSeries.Comment

Description

The comment on the reference series.

Syntax

object.Comment

Part	Attribute	Type	Description
`object`	Required	ISReferenceSeries	The `object` always implements the ISReferenceSeries interface

Return Value

string

Example

Display the number of reference series and some information about them, including their comments.

Dim aReferenceSeriesCollection
Dim aReferenceSeries
Dim aMessage
Dim i   

Set aReferenceSeriesCollection = Profile.GetReferenceSeriesCollection

aMessage = "Reference Series Count = " & aReferenceSeriesCollection.Count & vbNewLine

for i = 0 to aReferenceSeriesCollection.Count - 1
  set aReferenceSeries = aReferenceSeriesCollection.Item (i)
  aMessage = aMessage & vbNewLine & (i + 1) & ". " &_
    "Series Name: " & aReferenceSeries.SeriesName & vbNewLine &_
    "-Comment: " & aReferenceSeries.Comment & vbNewLine &_
    "-ID: " & aReferenceSeries.ID & vbNewLine &_   
    "-Is Range: " & aReferenceSeries.IsRange & vbNewLine  
next  

Profile.MsgBox(aMessage)

Note:

In Profile Client v8 on User Interface Comment can be found in Maintain > Reference Series > Description.

Version information

Added in v7.8.0