Property AdjustedDetail As AdjustedDetail

Specifies whether the data query will return adjusted or unadjusted data.

• AdjustedDetail_Adjusted – Returns adjusted data. This is the default.
• AdjustedDetail_Unadjusted – Returns unadjusted data.

Property ApplyFormatting As Boolean

Specifies whether the custom number formatting is applied to numbers in the results. The default value is FALSE.

If the value is set to TRUE, the values of the DecimalPlaces, UseThousandsSeparator, NegativeFormat and ApplyNegativeColor properties will be applied to numbers in the query.

Property ApplyNegativeColor As Boolean

Specifies whether negative colors will be rendered in Red.  The default value is FALSE.

Property ColumnWidth As Double

Specifies the default column width for every column in the query.  The default value is 13.57 points.

Property CreateNewWorksheet As Boolean

By default, a data query returns resulting data in a separate worksheet for every symbol in the Worksheet Dimension. This property specifies whether to replace an existing worksheet if the workbook already contains a worksheet with the same name.  The default value is FALSE.

Property DecimalPlaces As Double

Specifies the number of decimals to show for each numeric data cell.  The default value is 0.

Property FormulasOutput As FormulasOutput

When DataOutput is set to DataOutput_Formulas, this property can be used to modify LVCELL() functions to use hard coded symbol names or as cell references to a cell containing the symbol name.

• FormulasOutput_NoCellReferences – Symbol names are hard coded. This is the default.
• FormulasOutput_CellReferences – Symbol names are replaced with cell references to the column or row heading containing the symbol name.

Property NegativeFormat As String

A number format string representing how negative numbers will be formatted. 

See Excel documentation on valid string formats.

Property RowDescriptionWidth As Double

Specifies the default column width for columns representing a symbol description.  The default value is 38.14 points.

Property RowNameWidth As Double

Specifies the default column width for column representing a symbol name. The default value is 22.71 points.

Property ShowFixedSymbols As String

Specifies whether a legend displaying the selections for the fixed dimensions will be displayed above the actual data.  The default value is FALSE.

Property ShowTimestamp As Boolean

Specifies whether the current date/time will be displayed above the actual data. 

The default value is FALSE.

Property Subtitle As String

Specifies a subtitle to be displayed above the data grid and below the title.

Property Title As String

Specifies a title to be displayed above the data grid.

Property UseThousandsSeparator As Boolean

Specifies whether thousands separators are used when formatting numbers.

Sub AddColumnSpec (symbolSpec As String)

Adds a symbol spec to the columns dimension representing the hierarchy you wish to query. You may add multiple column specs but only if the symbols are from the same dimension.

• Parameters:

  symbolSpec – String representing a single symbol spec. For example: TRIALBAL#99.

• Errors:

  ErrorCode.INVALID_PARAMETER – This error is thrown when the symbol spec is invalid or if the symbol being added has already been added in a row, worksheet or fixed dimension.

Sub AddRowSpec (symbolSpec As String)

Adds a symbol spec to the down dimension representing the hierarchy you wish to query. You may add multiple row specs but only if the symbols are from the same dimension.

• Parameters:

  symbolSpec – String representing a single symbol spec. For example: TRIALBAL#99.

• Errors:

  ErrorCode.INVALID_PARAMETER – This error is thrown when the symbol spec is invalid or if the symbol being added has already been added in a column, worksheet or fixed dimension.

Sub AddWorksheetSpec (symbolSpec As String)

Adds a symbol spec representing the hierarchy you want to query.  Each symbol in the spec will be added as a separate worksheet in the current workbook.

• Parameters:

  symbolSpec – String representing a single symbol spec. For example: TRIALBAL#99.

• Errors:

  ErrorCode.INVALID_PARAMETER – This error is thrown when the symbol spec is invalid or if the symbol being added has already been added as row, column or fixed dimension.

Sub ClearSpecs([dimensionName As String])

Removes all symbol specs for the specified dimension that have been added or loaded in the Data Query.

• Parameters:

  dimensionName – Optional string representing the dimension in which to clear.  If no dimension is specified, specs will be cleared for all dimensions.

• Errors:

  ErrorCode.INVALID_PARAMETER – This error is thrown when the specified dimension name is invalid.

Sub LoadQuery(fileName As String)

Loads a data query that has been previously built and saved from the menu option: Data Query.

• Parameters:

  filename  – String representing the full path to the query file to load. For example: C:\SymbolQuery.lvqsq.

• Errors:

  ErrorCode.INVALID_PARAMETER – This error is thrown when the file cannot be loaded.

Sub RunToWorksheet([worksheetName As String], [cell As String])

Runs a symbol query and places the results into the specified worksheet and cell location.

• Parameters:

  worksheetName  – Optional string representing the name of the worksheet to place the results.  If the worksheet does not exist, it will be created.  If the worksheetName parameter is not specified, the current worksheet will be used.

  cell – Optional string representing the cell location to begin the symbol query. If the cell parameter is not specified, the default cell location A1 will be used.

• Errors:

  ErrorCode.INVALID_PARAMETER – This error is thrown when the query is invalid or when the specified worksheet name or cell are invalid.

Sample Usage

Sub RunDataQuery()

On Error GoTo ErrorHandler

Dim query As Longview.DataQuery

Set query = New Longview. DataQuery

query.AdjustedDetail = AdjustedDetail_Unadjusted

query.DataMode = DataMode_CTA

query.LoadQuery “C:\MyDataQuery.lvqde”

query.ClearSpecs “Entities”

query.AddRowSpec “CANADA#99”

query.SetFixedSymbol “DIM10SET”

query.RunToWorksheet “B1”

ErrorHandler:

If Err.Number <> 0 Then

MsgBox “Unable to run Data Query (“ & Err.Number & “) – “ &

Err.Description

End If

End Sub