Simple
Simple
Detailed
Stonefield Query SDK
Introduction
What's New in This Version
Licensing
Software Maintenance
Trial Version
Technical Support
Copyright
Quick Start
Sample Project
Step 1: Setting up Options
Step 2: Create a Stonefield Query Project
Step 3: Customizing the Data Dictionary
Step 4: Specify Configuration Settings
Step 5: Test Your Project
Step 6: Deploy to Your Users
Stonefield Query Studio
Introduction
Working with Stonefield Query Studio
Menu and Toolbar Functions
Panels
Creating a New Stonefield Query Project
Opening an Existing Stonefield Query Project
Data Dictionary
Adding a Database to the Data Dictionary
Database Properties
Table Properties
Creating a Subtable
Creating a Virtual Table
Field Properties
Creating a Calculated Field
Creating a Relation
Relation Properties
Finding Possible Relations
Refreshing the Data Dictionary
Updating a Virtual or Subtable to Match the Main Table
Viewing Table Contents
Filtering the Data Dictionary
Expression Builder
Versioning
Exporting the Data Dictionary to Microsoft Excel
Cleaning up the Project
Application Views
Creating a Data Group
Creating a User Group
Configuration Settings
Support Multi-Languages
Default Language
Message for Invalid Directory
Default Table for New Reports
Default Data Group for New Reports
Default Application View for New Reports
Description for Data Sources
Description for Data Groups
Description for Application Views
Display "All" Data Group
Use Application Views by Default
Allow Access to Reports When No Access to Fields
Enable Table/Field Favorites
Number of Days for Demo Version
Application Name
Short Application Name
Display Application Name
Company Name
Company Web Site
Support Email
Sales Email
Sales Phone
URL for Technical Support Site
URL for Knowledgebase
URL for Customer Portal
URL for News Feeds
Tag for News Feed
Logo Image File
Icon File
Support Contact Information
Registry Key for Earlier Version
Allow Multiple Data Sources
Allow Queries on Multiple Data Sources
User Can Edit SQL Statement
Include Joins in the WHERE Clause
Stonefield Query Performs Joins
Default for Auto-Adding DISTINCT
User Can Manage Data Sources
Use DSNless Connection
Share Database Connections
Table to Test
Use a Schema for Queries
Use "with (nolock)"
Need Target Application Directory
Target Application's Name
Message for Invalid Target App Directory
Support Online Updates
URL for Online Updates
Username for Online Updates
Password for Online Updates
Updates File for Online Updates
Support Maintenance Reminder
Scripts
Script Languages
Creating a New Script
Adding Existing Scripts to a Project
User-Defined Scripts
Data Object Scripts
GetDataSources
OpenDataSource
GetSQL
Select
Event Scripts
About.Settings
Application.AfterLogin
Application.AfterSetup
Application.BeforeLogin
Application.BeforeSetup
Application.BeforeShowWizard
Application.BeforeShutdown
Application.GetDefaultTargetAppDir
Application.GetShortcutParameters
Application.ReportsExplorerActivated
Application.ReportsExplorerReady
Application.SetupMenu
Application.Shutdown
Application.SubmitTicket
Application.ValidateCommonDir
Application.ValidateTargetAppDir
DataEngine.AfterDataEnvironmentCleared
DataEngine.AfterDataGroupsLoaded
DataEngine.AfterResultSetRetrieved
DataEngine.BeforeCreateSQLStatement
DataEngine.BeforeResultSetRetrieved
DataEngine.BeforeSendSQLStatementToDatabase
DataEngine.FilterChanged
DataEngine.FinalizeSQLStatement
DataEngine.GetCustomMetaData
DataEngine.GetDataSourceDescription
DataEngine.GetObjectVersion
DataEngine.HandleSQLError
DataEngine.SetOperatorList
Options.Changed
Options.Settings
Options.Validate
OutputOptions.Settings
Registration.Settings
ReportEngine.AfterAddField
ReportEngine.AfterCreateFile
ReportEngine.AfterGetFolders
ReportEngine.AfterReportPrepared
ReportEngine.AfterRunReport
ReportEngine.AfterSendEmail
ReportEngine.BeforeCreateFile
ReportEngine.BeforeRunReport
ReportEngine.BeforeSendEmail
ReportEngine.ImportReport
ReportEngine.OnFinishWizard
ReportEngine.PreviewReport
ReportEngine.SetReportProperties
ReportEngine.SetupCrystalReport
Scheduler.GetCommandLine
Setup.Changed
Setup.Settings
Setup.Validate
Stonefield Query Security
Multi-Language Support
Launching Stonefield Query
Importing a Data Dictionary
Querying the Data Dictionary
Deploying Stonefield Query
Creating a Help File
Providing Sample or Standard Reports
Providing Sample or Standard Templates
Changing the File Description for SFQuery.exe
Creating a Setup Executable
Tutorials
Creating a Project
Microsoft Access
Microsoft SQL Server
Accessing Multiple Data Sources
Allowing the User to Manage Data Sources
Microsoft Access and SQL Server Northwind
Accessing Local and Remote SQL Server Databases
Calculated Fields That Call Scripts
Joins Between Different Databases
Stonefield Query Object Model
Application Object
AddProperty
CreateObject
Decrypt
Encrypt
Execute
GetDataSetFieldName
GetINIValue
GetRegistryValue
GetValuesCollection
Log
OpenForm
PromptUserForValue
RegisterCursorToCloseAfterRun
SaveEmailSettings
SetINIValue
SetRegistryValue
SetViewerLicenses
ShowErrorMessage
ShowStatus
Shutdown
UpdateProgressBar
Collections
AddItem
Clear
Item
RemoveItem
AppView Object
AppViews Collection
AppViewField Object
AppViewFields Collection
CustomJoin Object
CustomJoins Collection
Database Object
ExecuteSQLStatement
OpenDataSource Method
Databases Collection
GetMainDatabase
DataEngine Object
AddToFavorites
AddToFields
AddToWhere
CancelReport
GetFieldsFromSQLStatement
GetTablesFromSQLStatement
GetValuesForField
GetValuesForParameter
GetWhereFromSQLStatement
ODBCFilterToLocalFilter
DataSource Object
Connect
Disconnect
DataSources Collection
AddItem Method
Field Object
Fields Collection
FilterCondition Object
FilterConditions Collection
Join Object
Joins Collection
Parameters Collection
Report Object
CreateOutput
GetReportFilter
GetReportFooter
GetReportHeader
RunReport
SetOutputToFile
ReportEngine Object
EditReport
GetFolders
GetReport
GetReports
NewReport
PreviewReport
PrintReport
RunReport
RunReportToFile
ReportField Object
ReportFields Collection
Sort Object
Sorts Collection
Table Object
Tables Collection
Users Collection
GetLicenseCount
IsValidUser
Login
User Object
How To
Activating Stonefield Query Studio
Adding a Database at Runtime
Adding an Existing Data Dictionary to a Project
Converting FoxFire Reports to Stonefield Query
Converting Stonefield Reports to Stonefield Query
Creating a Branded Version of Stonefield Query
Creating a Values Method Script for a Field
Customizing the Ribbon
Dealing with Errors
Defining an Enumerated Field Programmatically
Displaying a Splash Screen
Encrypting Files Output From a Report
Executing Custom Code in Stonefield Query Studio
Filling the Data Dictionary Automatically
Getting Diagnostic Information
Handling Dates Stored as Non-Date Values
Handling GMT Fields
Handling Null-Terminated Strings
Improving the Performance of Calculated Fields
Licensing Reports
Linking to Google Maps
Outputting Rich Text Fields
Removing Menu Items and Wizards
Running Stonefield Query from Other Applications
Command-Line Interface
SQProxy Object
Using SQProxy with IIS
Using SQProxy in .NET Applications
Sample ASP.NET Web Application
Specifying Libraries to Load
Specifying the Location of the Project File at Installation
Updating From Visual MaxFrame Professional
Updating Stonefield Query to the Latest Version
Using a Stored Procedure for Data Access
Using a Text File for a Data Source
Using a Web Service for a Data Source
Using Case-Insensitive Joins
Using Microsoft SQL Server
Using SQLookup to Avoid Subtables
Using SQLXML for a Data Source
Technical Reference
Data Dictionary Table Structure
Error Codes
Function Reference
Registry Settings
Security Tables
Stonefield Query Directories
Stonefield Query Project Files
Structure of Reports Table
Stonefield Query .NET Wrapper Classes
Namespace SFQWrapper
Class AppView
Caption
DataGroup
ErrorMessage
Fields
Key
MainList
Order
ParentKey
Class AppViewField
Caption
ErrorMessage
FieldName
Heading
Order
Class AppViewFields
AddItem
Clear
Item
Item
RemoveItem
RemoveItem
Count
ErrorMessage
Class AppViews
AddItem
Clear
Item
Item
RemoveItem
RemoveItem
Count
ErrorMessage
Class AskAtRuntimeValues
AddItem
Class CustomJoin
ErrorMessage
JoinType
Table1
Table2
Class CustomJoins
AddItem
Clear
Item
Item
RemoveItem
RemoveItem
Count
ErrorMessage
Class Database
ExecuteSQLStatement
ExecuteSQLStatement
OpenDataSource
OpenDataSource
Active
Connected
CurrentDataSource
DatabaseName
DataSourceName
DataSources
Description
ErrorMessage
MainDatabase
Quiet
Class Databases
AddItem
Clear
GetMainDatabase
Item
Item
RemoveItem
RemoveItem
Count
ErrorMessage
Class DataEngine
AddToFavorites
AddToFields
AddToWhere
GetFieldsFromSQLStatement
GetTableFromSQLStatement
GetTablesFromSQLStatement
GetValuesForField
GetValuesForField
GetValuesForParameter
GetValuesForParameter
AppViews
Databases
ErrorMessage
ExcludeConditions
Fields
FilterConditions
IncludeJoinsInWhere
Joins
PerformJoins
Tables
Class DataSource
Connect
Disconnect
BaseURL
CommandTimeout
ConnectionHandle
ConnectionString
ConnectionTimeout
Database
Datasource
Description
Driver
DSN
ErrorMessage
Method
OtherConnectInfo
Password
Server
Specifier
Type
UserDefined
UserName
UseTemplate
WSDLURL
Class DataSources
AddItem
AddItem
Clear
Item
Item
RemoveItem
RemoveItem
Count
ErrorMessage
Class Field
Alias
AllowValues
Calculated
Caption
Comment
Decimals
ErrorMessage
Exact
Expression
Favorite
FieldList
FieldName
Filterable
Format
Heading
Length
Order
Other
OutputLength
OutputType
Picture
Reportable
Roles
Sortable
SQExpression
Type
UserDefined
ValuesMethod
Version
Class Fields
AddItem
AddItem
Clear
Item
Item
RemoveItem
RemoveItem
AliasFilter
Count
ErrorMessage
Class FilterCondition
AskAtRunTime
CaseSensitive
Condition
Connection
Display
ErrorMessage
FieldName
IncludeInDisplay
Operator
Values
ValueType
Class FilterConditions
AddItem
AddItem
Clear
Item
Item
RemoveItem
RemoveItem
AskAtRuntimeOnly
Count
ErrorMessage
Class Folder
CreatedAt
CreatedBy
FolderName
HasChildren
HasFolders
HasParent
ID
ParentID
Class Folders
AddItem
Clear
Item
Item
RemoveItem
RemoveItem
Count
ErrorMessage
Class Join
ChildExpression
ChildTable
ErrorMessage
JoinExpression
JoinName
JoinType
ParentExpression
ParentTable
Version
Weight
Class Joins
AddItem
Clear
Item
Item
RemoveItem
RemoveItem
Count
ErrorMessage
Class Parameter
Name
Value
Class Parameters
AddItem
AddItem
Clear
Item
Item
RemoveItem
RemoveItem
Count
ErrorMessage
Class ReflectionService
CallMethod
GetProperty
SetProperty
Class Report
CreateOutput
GetAskAtRuntimeFilter
GetAskAtRuntimeFilterCount
GetReportFilter
GetReportFooter
GetReportHeader
RunReport
SetOutputToFile
SetOutputToFile
SetOutputToFile
Advanced
AllowDuplicates
AllowEmptyResultSet
AllowFilter
AllowSort
AskAtRunTime
BCCRecipients
CCRecipients
Comments
CustomJoins
DataGroup
DisplayFilter
Distinct
EmailBody
EmailSubject
EncodedName
EndPage
EraseFile
ErrorMessage
ExcludeConditions
Fields
FilterConditions
Footer
ForEachMode
HaveGroupedFields
Header
ID
Margin
Orientation
Output
OutputFileName
Recipients
Records
ReportName
ReportType
ShowTotalsInGroupHeader
Sorts
SQLSelect
StartPage
Summary
Template
Timestamp
UserName
Class ReportEngine
FillTreeView
GetFolders
GetFolders
GetFolders
GetReport
GetReports
GetReports
GetReports
RunReport
RunReport
RunReport
RunReport
RunReport
RunReportToFile
RunReportToFile
RunReportToFile
RunReportToFile
RunReportToFile
RunReportToFile
ErrorMessage
Class ReportField
Alias
AllowValues
Autofit
BackColor
Bookmark
Calculated
Caption
Chart
ChartFormat
ChartInputMask
ChartOrder
ChartTotalType
Comment
CursorFieldName
DataTrimming
Decimals
ErrorMessage
Exact
Expression
Favorite
FieldList
FieldName
Filterable
FontAlign
FontBold
FontItalic
FontName
FontSize
FontUnderline
ForeColor
Format
Group
GroupCount
GroupOnOneLine
Heading
HPosition
Length
NewPage
NoTotalsForOneRecord
Order
Other
OutputLength
OutputType
Picture
Reportable
ResetPage
Roles
ShowPercent
Sortable
SQExpression
Suppress
TotalType
Type
UseDefaultFormat
UseDefaultFormatForChart
UserDefined
ValuesMethod
Version
VPosition
Width
WidthOnReport
Class ReportFields
AddItem
AddItem
AddItem
Clear
Item
Item
RemoveItem
RemoveItem
Count
ErrorMessage
Class Reports
AddItem
Clear
Item
Item
RemoveItem
RemoveItem
Count
ErrorMessage
Class Settings
Address1
Address2
City
Company
Contact
Country
Email
Fax
Phone
PostalCode
Region
Class SFQApplication
AddProperty
AddProperty
Decrypt
Encrypt
Execute
GetDataSetFieldName
GetINIValue
GetINIValue
GetProperty
GetRegistryValue
GetRegistryValue
GetRegistryValue
GetValuesCollection
PromptUserForValue
PromptUserForValue
PromptUserForValue
SetINIValue
SetProperty
SetRegistryValue
SetRegistryValue
SetViewerLicenses
ShowErrorMessage
ShowStatus
Shutdown
UpdateProgressBar
ApplicationDataDirectory
ApplicationDirectory
ApplicationName
CalledFromProxy
CanEditReports
DataEngine
ErrorMessage
Parameters
ProjectDirectory
ReportEngine
ReportsDirectory
SerialNumber
ShortApplicationName
TargetApplicationDirectory
TimeZoneDesc
TimeZoneOffset
Users
Version
Class Sort
Alias
Ascending
Caption
ErrorMessage
FieldName
Group
Order
Class Sorts
AddItem
Clear
Item
Item
RemoveItem
RemoveItem
Count
ErrorMessage
Class Table
Alias
Caption
Database
DataGroup
ErrorMessage
Location
OriginalTable
Reportable
Roles
Schema
SubTableFilter
UserDefined
Version
Virtual
Class Tables
AddItem
Clear
Item
Item
RemoveItem
RemoveItem
Count
ErrorMessage
Class User
Administrator
Advanced
ErrorMessage
FirstName
LastName
License
Password
Roles
UserName
Class Users
AddItem
Clear
GetLicenseCount
GetLicenseCount
IsValidUser
Item
Item
Login
RemoveItem
RemoveItem
Administrator
Advanced
Count
ErrorMessage
UserName
Class ValueItem
IncludeTime
Value
Class Values
AddItem
AddItem
AddItem
Clear
Item
RemoveItem
Count
Namespace SQProxyWrapper
Class SQProxy
LoadProject
LoadProject
LoadProject
LoadProject
ErrorCode
ErrorMessage
Parameters
ProjectLoaded
ProxyTimeout
SQApplication
Frequently Asked Questions
Business Issues
Configuration Issues
Database Issues
Reporting Issues
Script Issues