ComponentOne Query 8.0
C1QueryFrame Object

C1QueryFrame Object Properties


BackColor

Returns/sets the background color of the control.

Border

Returns/sets a value that determines whether the control has 3D border.

Checkboxes

If set to True, checkbox is displayed in query items, its state defining whether to include or ignore the item.

Checked

Determines whether to include or ignore the specified query item.

ContentsType

Returns/sets the type of the control, whether it is used for specifying conditions or result fields.

CurrentItemID

Returns/sets the current (selected) item. It is unique ID.

DebugContextMenu

If True, the standard Internet Explorer context menu is used instead of the control's context menu at run time, for debug purposes.

DesignTimeTemplates

If set to False, template modification is ignored in control display at design time.

EditedValue

Sets/returns the value of a constant being edited by a custom editor.

EditedValueText

Sets/returns the textual representation value of a constant being edited by a custom editor.

Editing

Returns a value indicating whether editing of a constant is in progress.

EditTypeChecking

Determines whether an error is raised when a constant value cannot be converted to the required type.

Enabled

Returns/sets a value that determines whether an object can respond to user-generated events.

ErrorItemID

Returns the unique ID of the item affected by an error condition.

Font

Returns/sets the font used in the control.

ForeColor

Returns/sets the foreground color used in the control.

FormatDate

Formatting string for date values.

FullFieldNames

If True, the control shows full dot-separated field names containing folder names. (C1Query.PathSeparator is used instead of dot, if set by the programmer).

Item

Object providing access to individual items (conditions and result fields) of the control.

ManualRender

If True, HTML rendering is performed by the C1QRender() function in the script defined in HTML Templates.

SchemaControl

Returns/sets the name of the C1Query control containing the schema and performing SQL generation.

SchemaControlObject

Returns/sets (at run time) the C1Query control containing the schema and performing SQL generation.

TabInQuery

If True, the Tab key navigates between the control's items rather than between different controls.

TemplateAttributes

Returns/sets the template attribute with specified name.

Templates

Returns/sets the string modifying HTML templates defining control's look and UI.

TemplateUserData

Custom template parameters.

TypedEditing

If set to True, the control uses special editors for data types such as date/time, Boolean, numeric.

Wrap

Enables/disables wordwrap in the control. Used in C1QRender() script with ManualRender=True.


C1QueryFrame Object Methods


AddItem

Adds a new query item to the control.

Clear

Removes all query items from the control.

DeleteItem

Deletes a query item from the control.

ExitEdit

Ends editing of a constant.

FieldByID

Returns information about the folder field specified by its unique ID.

FieldNameToFieldID

Returns the field's unique schema ID given the field name.

GenerateHTML

Generates HTML for an item. Used in C1QRender() script with ManualRender=True.

GetItemIDAt

Returns the ID of the item at specified point coordinates (X,Y).

LoadFromXML

Loads query from a string.

LoadFromXMLFile

Loads query from a file.

LoadTemplatesFromFile

Loads templates from a file.

PerformMainMenuAction

Performs the action that would have been triggered by a main menu selection.

Render

Renders the current state of the query items on the control surface.

SaveToXML

Saves query to a string.

SaveToXMLFile

Saves query to a file.

SetCurrentElement

Makes an element current (selected) in the current item.

SetLookup

Retrieves lookup list of values from a data source.

SetTemplateAttribute

Modifies an attribute in HTML templates defining control's look and UI.

StartEdit

Activates editing of the active item's selected element.

VarTypeFromDataType

Returns the variant data type corresponding to a field data type.

WrapHTML

Adds the enclosing tags to an HTML representing an item. Used in C1QRender() script with ManualRender=True.


C1QueryFrame Object Events


AfterEdit

Occurs after a constant value has been modified by the user.

AfterMenu

Occurs after a menu item has been chosen from a menu.

AfterRender

Occurs when rendering is completed after change or Render call.

BeforeEdit

Occurs before editing a constant.

BeforeMenu

Occurs before a menu is opened.

BeforeSQLGeneration

Occurs before SQL generation and allows to change query items and syntax rules affecting resulting SQL.

Change

Occurs when an item element has been modified by the user.

Click

Occurs when the user presses and then releases a mouse button over the control.

DblClick

Occurs when the user double-clicks the control with the mouse.

EndEdit

Occurs on closing a custom editor.

Error

Occurs as a result of an error condition.

HideCustomEditor

Occurs when a custom editor is being hidden.

ItemFocusChange

Occurs after a different item and/or item element becomes current.

KeyDown

Occurs when the user presses a key.

KeyPress

Occurs when the user presses and releases an ANSI key.

KeyUp

Occurs when the user releases a key.

LookupValues

Occurs before showing the lookup list for a field.

MenuSelected

Occurs when a menu item is selected.

MouseDown

Occurs when a mouse button is pressed.

MouseMove

Occurs when the mouse pointer is moved across the control.

MouseUp

Occurs when the user releases the mouse button.

ShowCustomEditor

Occurs when a custom editor is being activated

SQLGenerationItem

Occurs before an item is included into the resulting SQL statement.

 

 

 


Copyright (c) GrapeCity, inc. All rights reserved.

Product Support Forum  |  Documentation Feedback