Class

# ReportPicture

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

## Description

A picture/image in a report created with the `Report Layout Editor</getting_started/using_the_ide/report_layout_editor>`.

## Properties

<div class="rst-class">

table-centered_columns_3_and_4

</div>

| Name                                 | Type                                               | Read-Only | Shared |
|--------------------------------------|----------------------------------------------------|-----------|--------|
| `Alignment<reportpicture.alignment>` | `PictureAlignment<reportpicture.picturealignment>` |           |        |
| `Back<reportpicture.back>`           | `Double</api/data_types/double>`                   |           |        |
| `BackColor<reportpicture.backcolor>` | `Color</api/data_types/color>`                     |           |        |
| `DataField<reportpicture.datafield>` | `String</api/data_types/string>`                   |           |        |
| `Height<reportpicture.height>`       | `Double</api/data_types/double>`                   |           |        |
| `Image<reportpicture.image>`         | `Picture</api/graphics/picture>`                   |           |        |
| `Left<reportpicture.left>`           | `Double</api/data_types/double>`                   |           |        |
| `Name<reportpicture.name>`           | `String</api/data_types/string>`                   | ✓         |        |
| `Report<reportpicture.report>`       | `Report</api/printing/reporting/report>`           |           |        |
| `Stretch<reportpicture.stretch>`     | `Boolean</api/data_types/boolean>`                 |           |        |
| `Tag<reportpicture.tag>`             | `Variant</api/data_types/variant>`                 |           |        |
| `Top<reportpicture.top>`             | `Double</api/data_types/double>`                   |           |        |
| `Visible<reportpicture.visible>`     | `Boolean</api/data_types/boolean>`                 |           |        |
| `Width<reportpicture.width>`         | `Double</api/data_types/double>`                   |           |        |

## Methods

<div class="rst-class">

table-centered_column_4

</div>

| Name                                     | Parameters                                      | Returns                          | Shared |
|------------------------------------------|-------------------------------------------------|----------------------------------|--------|
| `Constructor<reportpicture.constructor>` | controlName As `String</api/data_types/string>` |                                  |        |
| `ControlType<reportpicture.controltype>` |                                                 | `String</api/data_types/string>` |        |

## Events

<div class="rst-class">

table-centered_column_4

</div>

| Name                                           | Parameters | Returns |
|------------------------------------------------|------------|---------|
| `AfterPrinting<reportpicture.afterprinting>`   |            |         |
| `BeforePrinting<reportpicture.beforeprinting>` |            |         |

## Enumerations

<div id="reportpicture.picturealignment">

<div class="rst-class">

forsearch

</div>

</div>

ReportPicture.PictureAlignment

### PictureAlignment

> The available alignments for a <span class="title-ref">ReportPicture</span>. Used by the `Alignment<reportpicture.alignment>` property.
>
> | Name            |
> |-----------------|
> | TopLeft = 1     |
> | TopRight = 2    |
> | Center = 0      |
> | BottomLeft = 3  |
> | BottomRight = 4 |

## Property descriptions

<div id="reportpicture.alignment">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

ReportPicture.Alignment

**Alignment** As `PictureAlignment<reportpicture.picturealignment>`

> The alignment of the picture inside the <span class="title-ref">ReportPicture</span>.

<div id="reportpicture.back">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

ReportPicture.Back

**Back** As `Double</api/data_types/double>`

> The opacity level of the background.

<div id="reportpicture.backcolor">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

ReportPicture.BackColor

**BackColor** As `Color</api/data_types/color>`

> The background color for the object. If the control has a HasBackColor property, it must be set to `True</api/language/true>` to have the BackColor displayed.

<div id="reportpicture.datafield">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

ReportPicture.DataField

**DataField** As `String</api/data_types/string>`

> The name of the field from the datasource to bind to the control.
>
> If a <span class="title-ref">ReportPicture</span> has both an Image and a DataField specified, then the DataField will be used. The picture assigned to the Image property acts as a default if there is no image assigned to the DataField or cannot be read successfully.

<div id="reportpicture.height">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

ReportPicture.Height

**Height** As `Double</api/data_types/double>`

> The height of the control in `Units<reports.units>`. Height is relative to the section the control is in.

<div id="reportpicture.image">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

ReportPicture.Image

**Image** As `Picture</api/graphics/picture>`

> The image to be displayed in the <span class="title-ref">ReportPicture</span>.

<div id="reportpicture.left">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

ReportPicture.Left

**Left** As `Double</api/data_types/double>`

> The left side of the control in `Units<reports.units>`. Left is relative to the section the control is in.

<div id="reportpicture.name">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

ReportPicture.Name

**Name** As `String</api/data_types/string>`

> The name of the object.
>
> This property is read-only.

<div id="reportpicture.report">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

ReportPicture.Report

**Report** As `Report</api/printing/reporting/report>`

> The report to which the object belongs.

<div id="reportpicture.stretch">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

ReportPicture.Stretch

**Stretch** As `Boolean</api/data_types/boolean>`

> If `True</api/language/true>`, the image will be stretched to fill the interior of the control or scaled to fit the entire <span class="title-ref">ReportPicture</span>.
>
> If the image is larger than the control, it will be reduced to fit inside the control. If the aspect ratio of the image does not match that of the control, it will appear distorted. The default is `True</api/language/true>`.

<div id="reportpicture.tag">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

ReportPicture.Tag

**Tag** As `Variant</api/data_types/variant>`

> A value that can be associated with the shape.

<div id="reportpicture.top">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

ReportPicture.Top

**Top** As `Double</api/data_types/double>`

> The top of the control in `Units<reports.units>`. Top is relative to the section the control is in.

<div id="reportpicture.visible">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

ReportPicture.Visible

**Visible** As `Boolean</api/data_types/boolean>`

> If `True</api/language/true>`, the control is visible. The default is `True</api/language/true>`.

<div id="reportpicture.width">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

ReportPicture.Width

**Width** As `Double</api/data_types/double>`

> The width of the control in `Units<reports.units>`. Width is relative to the section the control is in.

## Method descriptions

<div id="reportpicture.constructor">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

ReportPicture.Constructor

**Constructor**(controlName As `String</api/data_types/string>`)

> Creates a new <span class="title-ref">ReportPicture</span> with the name passed.
>
> <div class="note">
>
> <div class="title">
>
> Note
>
> </div>
>
> `Constructors</api/language/constructor>` are special methods called when you create an Object With the `New</api/language/New>` keyword And pass In the parameters above.
>
> </div>

<div id="reportpicture.controltype">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

ReportPicture.ControlType

**ControlType** As `String</api/data_types/string>`

> Returns the type of the control.

## Event descriptions

<div id="reportpicture.afterprinting">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

ReportPicture.AfterPrinting

**AfterPrinting**

> The <span class="title-ref">ReportPicture</span> has just been printed.

<div id="reportpicture.beforeprinting">

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

</div>

<div class="rst-class">

forsearch

</div>

ReportPicture.BeforePrinting

**BeforePrinting**

> The <span class="title-ref">ReportPicture</span> is about to be printed.

## Notes

The Report Editor can print pictures that are stored in a SQLite Database. Use a <span class="title-ref">ReportPicture</span> in a Report Editor form. SQLiteDatabase stores pictures in Binary fields but the reporting engine can convert the contents of a Binary field so that the picture can be imaged. The user does not need to do anything special to use a <span class="title-ref">ReportPicture</span> field.

To print a picture from a SQLiteDatabase, assign the field name to the DataField property of a <span class="title-ref">ReportPicture</span>. Deselect the Stretch property if you want the image to appear at 100% and set the alignment property if the pictures do not take up all the area of the ReportPictures.

## Compatibility

|                       |         |
|-----------------------|---------|
| **Project Types**     | Desktop |
| **Operating Systems** | All     |

<div class="seealso">

`RBReportControl</api/printing/reporting/rbreportcontrol>` parent class; `Reports Module</api/printing/reporting/reports_module>` module; `RBReportDocument</api/printing/reporting/rbreportdocument>`, `Report</api/printing/reporting/report>`, `ReportField</api/printing/reporting/reportfield>`, `ReportLabel</api/printing/reporting/reportlabel>`, `ReportLineShape</api/printing/reporting/reportlineshape>`, `ReportOvalShape</api/printing/reporting/reportovalshape>`, `ReportRectangleShape</api/printing/reporting/reportrectangleshape>`, `ReportRoundRetangleShape</api/printing/reporting/reportroundrectangleshape>` classes.

</div>