ReportBox

Assembly: Report;

Namespace: Prognoz.Platform.Interop.Report;

Description

The ReportBox class introduces component of the development environment that enables the user to display data of regular reports.

Properties inherited from IReportBox

  Property name Brief description

BorderStyle

The BorderStyle property determines a component border style.

ControlPanelAllowed

The ControlPanelAllowed property determines whether the control panel is displayed.

DisplayNumericColumnNames

The DisplayNumericColumnNames property determines whether numeric column names are displayed in a component.

DisplayTabs

The DisplayTabs property determines whether sheet tabs should be displayed.

Report

The Report property determines the UiReport component that is used as a data source.

Properties inherited from IControl

  Property name Brief description

Align

The Align property determines component alignment within its parent component.

AllowDrag

The AllowDrag property determines whether an object can be dragged from a component.

AllowDrop

The AllowDrop property determines whether a component can accept a dragged object.

Anchors

The Anchors property returns settings determining % of the resize for the current component when the parent component is resized.

Brush

The Brush property determines the brush that is used to fill the component area.

ClientHeight

The ClientHeight property determines the height of the client component area.

ClientWidth

The ClientWidth property determines the width of the client component area.

Color

The Color property determines a component background color.

Cursor

The Cursor property determines how the cursor looks like when is it hovered over a component during form execution.

Enabled

The Enabled property determines whether the component is available for the user.

Focused

The Focused property returns True if this component is focused.

Font

The Font property determines parameters of the font that is used to display text in a component.

Height

The Height property determines component height in pixels.

HelpContext

The HelpContext property determines a unique index for a section of a context help for this component.

Hint

The Hint property determines a tooltip text displayed on hovering over a component.

HintTimeout

The HintTimeout property determines for how long a tooltip is displayed.

Left

The Left property determines a coordinate of the component left edge in pixels.

Parent

The Parent property determines a parent component.

ParentColor

The ParentColor property determines whether a component inherits the color of the parent component.

ParentFont

The ParentFont property determines whether a component uses the font of the parent component.

ParentShowHint

The ParentShowHint property determines when a tooltip is displayed.

PopupMenu

The PopupMenu property determines a context menu displayed when a component is clicked using the right mouse button.

Scrolls

The Scrolls property returns parameters of component's scrollbars.

ShowHint

The ShowHint property determines whether a tooltip is displayed when a component is hovered.

TabOrder

The TabOrder property determines a component position in a tab order.

TabStop

The TabStop property determines whether the component must be focused when the Tab button is pressed.

Text

The Text property determines a row identifying a component for the user.

Top

The Top property determines a coordinate of the component top edge in pixels.

Visible

The Visible property determines whether the component is displayed when a form is executed.

Width

The Width property determines horizontal size of a component in pixels.

Properties inherited from IComponent

  Property name Brief description

ComponentCount

The ComponentCount property returns the number of child components located on the parent component.

Components

The Components property returns a child component, which index is passed via the input parameter.

Data

The Data property is used to store any custom data.

Name

The Name property determines a component name.

Tag

The Tag property is not used by the compiler. The user can change the value of the Tag property and use it at his own discretion.

Methods inherited from IReportBox

  Method name Brief description

ClientToTab

The ClientToTab method converts coordinates of the ReportBox component into coordinates of the report, which is the data source for this component.

FindReplace

Outdated. Use the IReportBox.FindReplaceEx method.

FindReplaceEx

The FindReplaceEx method opens the Find and Replace dialog box in the regular report.

ShowBasicDataDialog

The ShowBasicDataDialog method opens the Source Data dialog box for the selected regular report chart.

Methods inherited from IControl

  Method name Brief description

BringToFront

Outdated.The BringToFront method brings the component to front.

ClientToScreen

The ClientToScreen method converts the coordinates of a point specified relative to the component coordinate system to screen coordinates.

DoDragDrop

The DoDragDrop method enables the user to start dragging operation.

GetImage

The GetImage method returns a graphic presentation of a component together with all child components.

ScreenToClient

The ScreenToClient method converts screen coordinates of a point to coordinates specified relative to the component coordinate system.

SendToBack

Outdated. The SendToBack method sends the component to back.

SetFocus

The SetFocus method sets focus to this component.

Events

  Event name Brief description

OnAfterDeleteRange

The OnAfterDeleteRange event occurs after removing ranges/rows/columns.

OnAfterEdit

The OnAfterEdit event occurs after editing data of a table cell.

OnAfterInsertRange

The OnAfterInsertRange event occurs after adding ranges/rows/columns.

OnAfterObjectChange

The OnAfterObjectChange event occurs after object change.

OnAutoFilter

The OnAutoFilter event occurs before autofiltering.

OnBeforeCellChange

The OnBeforeCellChange event occurs before changing the value of any table cell.

OnBeforeColumnResize

The OnBeforeColumnResize event occurs before resizing a table column.

OnBeforeDeleteRange

The OnBeforeDeleteRange event occurs before removing ranges/rows/columns.

OnBeforeEdit

The OnBeforeEdit event occurs before you start editing data of a table cell.

OnBeforeExpanderChanged

The OnBeforeExpanderChanged event occurs before changing expander state in a table cell.

OnBeforeInsertRange

The OnBeforeInsertRange event occurs before adding ranges/rows/columns.

OnBeforeObjectChange

The OnBeforeObjectChange event occurs before changing an object.

OnBeforeRowResize

The OnBeforeRowResize event occurs before resizing a table row.

OnBeginInteractiveSelectionChange

The OnBeginInteractiveSelectionChange event occurs when a user starts dragging selected data grid area.

OnCellChange

The OnCellChange event occurs after changing the value of any table cell.

OnCellClick

The OnCellClick event occurs on mouse click on any table cell.

OnCellPictureClick

The OnCellPictureClick event occurs on mouse click on the image in any table cell.

OnChangeCellContent

The OnChangeCellContent event occurs if a table cell contents has been changed.

OnColumnClick

The OnColumnClick event occurs on mouse click on the heading of any table columns.

OnColumnResize

The OnColumnResize event occurs after changing the size of table column.

OnColumnResizing

The OnColumnResizing event occurs at each visible change of table column size.

OnEditorTextChanged

The OnEditorTextChanged event occurs on visual editing of cell data.

OnEndInteractiveSelectionChange

The OnEndInteractiveSelectionChange event occurs when the user finishes dragging selected data grid area.

OnExpanderChanged

The OnExpanderChanged event occurs on changing expander state in a table cell.

OnHyperlinkClick

The OnHyperlinkClick event occurs on mouse click on a hyperlink in a table cell.

OnInteractiveSelectionChange

The OnInteractiveSelectionChange event occurs when a user drags selected data grid area.

OnObjectActivate

The OnObjectActivate event occurs when the object on the regular report sheet is activated/deactivated.

OnRowClick

The OnRowClick event occurs on mouse click on the heading of any table rows.

OnRowResize

The OnRowResize event occurs after changing the size of table row.

OnRowResizing

The OnRowResizing event occurs at each visible change of table row size.

OnScaleChange

The OnScaleChange event occurs on changing the table scale.

OnSelectionChange

The OnSelectionChange event occurs on changing the selection of cells or cell groups.

OnTableClick

The OnTableClick event occurs on mouse click on the region at the intersection of headings of rows and columns, which controls selection of the whole table.

Events inherited from IControl

   Event name Brief description

OnBeginDrag

The OnBeginDrag event occurs for the component when the user starts to drag an object from the component.

OnClick

The OnClick event occurs if the user clicks a component area with the main mouse button.

OnControlMove

The OnControlMove event occurs when a component is moved.

OnControlResize

The OnControlResize event occurs when a component is resized.

OnDblClick

The OnDblClick event occurs if the user double-clicks a component area with the mouse button.

OnDragDrop

The OnDragDrop event occurs for the component, if the user drops the dragged object over it.

OnDragEnter

The OnDragEnter event occurs when a dragged object enters the component area.

OnDragLeave

The OnDragLeave event occurs when a dragged object leaves the borders of this component.

OnDragOver

The OnDragOver event occurs for the component when the user drags an object over it.

OnEnter

The OnEnter event occurs when a component receives focus.

OnExit

The OnExit event occurs when a component loses focus.

OnHScroll

The OnHScroll event occurs when horizontal scrollbar slider changes its position.

OnKeyDown

The OnKeyDown event occurs if a component is focused and a keyboard key is pressed.

OnKeyPress

The OnKeyPress event occurs if a component is focused when the user presses a character key.

OnKeyPreview

The OnKeyPreview event occurs prior to each event requiring clicking.

OnKeyUp

The OnKeyUp event occurs if the component is focused and the user releases any button previously pressed.

OnMouseDown

The OnMouseDown event occurs when the pointer is in component area and a mouse button is pressed.

OnMouseEnter

The OnMouseEnter event occurs when mouse cursor enters the component area.

OnMouseHover

The OnMouseHover event occurs when mouse cursor is held in the component area.

OnMouseLeave

The OnMouseLeave event occurs when mouse cursor leaves the component area.

OnMouseMove

The OnMouseMove event occurs when the cursor is moved over the component.

OnMouseUp

The OnMouseUp event occurs when the mouse button is released and the cursor is in the component area.

OnMouseWheel

The OnMouseWheel event occurs if the component has focus when the mouse wheel is rotated.

OnVScroll

The OnVScroll event occurs when vertical scrollbar slider changes its position.

See also:

Report Assembly Classes