Active Query Builder 2 .NET Edition reference
QueryBuilder Class Members
Properties  Methods  Events

The following tables list the members exposed by QueryBuilder.

Public Constructors
 NameDescription
Public ConstructorQueryBuilder ConstructorOverloaded. Initializes a new instance of the QueryBuilder component.  
Top
Public Properties
 NameDescription
Public PropertyActiveSubQueryProvides access to the currently visible to end-user sub-query.  
Public PropertyAddObjectFormOptionsDetermines appearance of the Add Object Form.  
Public PropertyBehaviorOptionsAllows you to tune the way Active Query Builder parses and builds SQL queries.  
Public PropertyDatabaseSchemaTreeReturns an interface to the Database Schema Tree View control.  
Public PropertyDatabaseSchemaTreeOptionsContains various properties of the Database Schema Tree control.  
Public PropertyDataSourceOptionsContains various properties of the Design Pane.  
Public Propertystatic (Shared in Visual Basic)DefaultImageListGets the list of default icons.  
Public PropertyDesignPaneOptionsDetermines appearance of the objects within the Design Pane.  
Public PropertyExpressionEditorGets or sets a reference to the Expression Editor interface that allows to edit SQL expressions and criteria in a multi-line text editor with code auto-completion and syntax highlight.  
Public PropertyIsUpdatingIndicates that the component is in update mode now.  
Public PropertyLanguageGets or sets the language.  
Public PropertyLayoutSQLGets or sets the SQL query text among with layout, i.e. sizes and positions of objects within the Design Pane in XML format.  
Public PropertyMetadataContainerReturns a reference to the Metadata Container, an object to hold information about database schema, database objects and their attributes.  
Public PropertyMetadataLoadingOptionsDetermines rules of loading database schema information to the Metadata Container.  
Public PropertyMetadataProviderGets or sets a reference to the Metadata Provider object used to retrieve metadata from a database or from another source.  
Public PropertyMetadataStructureGets or sets the reference to the Metadata Structure object that represents the content of Metadata Container in a tree-like form.  
Public PropertyMetadataStructureOptionsContains various properties that affect on displaying of the Metadata Structure.  
Public PropertyOfflineModeAllows to switch the component between normal and "Offline" modes.  
Public Propertystatic (Shared in Visual Basic)OverrideDevExpressThemeColorsGets or sets a value indicating whether to override DevExpress controls theme colors.  
Public PropertyPanesConfigurationOptionsAllows you to configure layout of the main parts of the component: Design Pane, Query Columns List, Database Schema Tree and Query Structure Tree.  
Public PropertyParametersAllows to retrieve information about parameters that were used in the query.  
Public PropertyQueryProvides access to the main Query object.  
Public PropertyQueryColumnListOptionsContains various properties of the Query Column List control.  
Public PropertyQueryStatisticsAllows to retrieve various information about the query: list of used database objects and their fields, list of output query columns.  
Public PropertyQueryStructureTreeReturns an interface to the Query Structure Tree View control.  
Public PropertyQueryStructureTreeOptionsContains various properties of the Query Structure Tree.  
Public PropertyResultQueryASTGets the abstract sytnax tree of result SQL query.  
Public PropertyRightToLeftLayoutGets or sets a value indicating whether right-to-left mirror placement is turned on.  
Public PropertySleepModeIndicates that the component is in the "Sleep" Mode.  
Public PropertySQLUse this property to get or set SQL query text in response to user actions.  
Public PropertySQLChangingIndicates that the process of updating the query is running now.  
Public PropertySQLContextDetermines context of the query building, parsing and SQL generation processes.  
Public PropertySQLGenerationOptionsDetermines SQL query text generation rules for the QueryBuilder.SQL property.  
Public PropertySubQueriesLists all sub-queries in the query.  
Public PropertySyntaxProviderGets or sets a reference to the Syntax Provider object used to define SQL syntax rules of specific database servers.  
Public PropertyTabsReturns an interface to the Sub-Query Tab control.  
Public Propertystatic (Shared in Visual Basic)UseDevExpressControlsAllows to switch component's visual controls from standard .NET controls to DevExpress WinForms controls.  
Public PropertyVisualOptionsContains visual options that are not related to any pane.  
Top
Public Methods
 NameDescription
Public MethodBeginUpdatePrevents the component from SQL generation until the EndUpdate method is called.  
Public MethodClearClears the query.  
Public MethodClearSearchBoxClears the text in Database Schema Tree search box.  
Public MethodClearSearchResultsClears search results in the Database Schema Tree and restores the original metadata structure.  
Public Methodstatic (Shared in Visual Basic)EditMetadataContainerOverloaded. Shows the Metadata Editor form to edit content of the Metadata Container.  
Public Methodstatic (Shared in Visual Basic)EditMetadataContainerStandaloneOverloaded. Shows the Metadata Editor form with the content of given MetadataContainer object in the Standalone mode, i.e. as a standalone application.  
Public MethodEndUpdateResumes SQL generation after it was suspended by the BeginUpdate method.  
Public MethodGetSubQueryListReturns list of all sub-queries in the query.  
Public MethodGetUnionSubQueryListReturns list of all union sub-queries in the query.  
Public MethodInitializeDatabaseSchemaTreeInitializes the database schema tree.  
Public MethodIsSearchingIndicates the search for database objects is in progress.  
Public MethodPaintDesignPaneToBitmapGets bitmap of the Design Pane.  
Public MethodRefreshDatasourcesMetadataRefreshes the list of fields for datasources of the current query.  
Public Methodstatic (Shared in Visual Basic)ShowAboutDialogShows the About dialog window.  
Public MethodShowAddObjectFormShows the Add Object Form.  
Public Methodstatic (Shared in Visual Basic)ShowMetadataContainerLoadWizardDisplays the Metadata Container load wizard.  
Public MethodShowQueryBuilderPropertiesFormDisplays the dialog that allows to set various properties of the Query Builder and the SQL Builder components visually.  
Public MethodStopSearchStops searching for database objects.  
Top
Public Events
 NameDescription
Public EventActiveSubQueryChangedInvoked when currently visible sub-query is changed.  
Public EventActiveUnionSubQueryChangedInvoked when currently visible union sub-query is changed.  
Public EventAfterPropertiesDialogInvoked after any of the properties dialogs (Sub-query, DataSource, Link properties) are closed.  
Public EventBeforeDatasourceFieldDragInvoked when the user starts to drag a DataSource Field at the Design Area.  
Public EventBeforePropertiesDialogInvoked before any of the properties dialogs (Sub-query, DataSource, Link properties) is shown.  
Public EventControlCreatedInvoked when a control is created inside the component.  
Public EventControlDestroyingInvoked before the control is destroyed inside the component.  
Public EventCustomExpressionBuilderIs called to edit SQL expression of the Expression or Criteria column cell of the Query Columns Grid when the user clicks the ellipsis button.  
Public EventCustomizeDatasourceCaptionIs called to customize the caption of a DataSource at the Design Area.  
Public EventCustomizeDatasourceFieldListIs called to customize the field list of a DataSource at the Design Area.  
Public EventDataSourceAddedInvoked when DataSource is added by the user.  
Public EventDataSourceAddingInvoked when DataSource is about to be added by the user.  
Public EventDataSourceDeletingInvoked when DataSource is about to be deleted by the user.  
Public EventDatasourceFieldAddedInvoked when Field is added to the query by checking it at the DataSource field list.  
Public EventDatasourceFieldAddingInvoked when Field is about to be added to the query by checking it at the DataSource field list.  
Public EventDatasourceFieldRemovedInvoked when Field is removed from the query by unchecking it at the DataSource field list.  
Public EventDatasourceFieldRemovingInvoked when Field is about to be deleted from the query by unchecking it at the DataSource field list.  
Public EventDesignPaneLayoutChangedFired when layout of objects on the design pane is changed.  
Public EventDestroyingOccurs before the component is destroyed.  
Public EventFieldListDrawItemCalled to draw an item of the DataSource Field List.  
Public EventFocusedDesignPaneControlChangedOccurs when a focused object at the Design Pane is changed.  
Public EventGetDatabaseSchemaTreeToolTipTextFired to request the tooltip text for objects in the Database Schema Tree.  
Public EventGetDataSourceFieldToolTipTextFired to request the tooltip text for fields in the Datasource field list.  
Public EventGetDiagramObjectWidthCalled to calculate width of the newly added datasource.  
Public EventGetProcedureParametersFired when the component requests parameter values for stored procedure or function.  
Public EventGridCellValueChangedInvoked when one of the Query Columns Grid Control cells is changed by the user.  
Public EventGridCellValueChangingInvoked when one of the Query Columns Grid Control cells is about to be changed by the user.  
Public EventLanguageChangedFired on changing the Language property.  
Public EventLinkChangedInvoked when the Link properties are changed by the user.  
Public EventLinkChangingInvoked when the Link properties are about to be changed by the user.  
Public EventLinkCreatedInvoked when the link between datasources is created by the user.  
Public EventLinkCreatingInvoked when the link between two datasources is about to be created by the user.  
Public EventLinkDeletingInvoked when the link between datasources is about to be deleted by the user.  
Public EventLinkDragOverInvoked when the user drags a DataSource Field over the other DataSource Field to create a link between these fields.  
Public EventQueryAwakeOccurs when the component is currently in the "Sleep" mode and the user starts to build a query visually.  
Public EventSleepModeChangedInvoked when the component is turns the "Sleep" mode on and off.  
Public EventSqlErrorInvoked on SQL text parsing error.  
Public EventSQLUpdatedOccurs each time the component updates the output SQL query text.  
Public EventUserMessageFired when the component is about to show the warning message to the user.  
Public EventValidateContextMenuIs called before any of the component's context menus is shown.  
Top
See Also

Reference

QueryBuilder Class
ActiveDatabaseSoftware.ActiveQueryBuilder Namespace

 

 


© Copyright 2005-2012 ActiveDBSoft. All rights reserved.

Send Feedback