Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA™ Engineering

Comment Capture

  • Last UpdatedOct 30, 2024
  • 6 minute read

The Comment Capture control is used to add a comment capture image to a report.

On the Properties window, the Comment Capture control properties are divided into the following tabs:

Appearance

Background Color

Specifies the background colour of controls. The functionality is also available on the Report Designer tab ().

Border Color, Border Dash Style, Border Width and Borders

Specifies border settings for controls.

Formatting Rules

Displays the Formatting Rules Editor window, used to choose which rules are applied to a report during report generation, and to define the priority of the applied rules.

Location

Specifies the location of the control in report measurement units.

Padding

Specifies indent values used to render the contents of the controls.

Size

Specifies the size of the control in report measurement units.

Style Priority

Defines the priority of various styles (for example, background colour or border colour).

Styles

Defines odd and even styles for the controls, as well as assigning an existing style to the them (or a newly created one).

Behavior

Anchor Horizontally

Specifies the horizontal anchoring style of the control, so that after page rendering it stays attached to the left control, right control, or both. The property setting is useful for data-bound controls located between controls, which are able to resize depending on their contents.

Anchor Vertically

Specifies the vertical anchoring style of the control, so that after page rendering it stays attached to the top control, bottom control, or both. The property setting is useful for data-bound controls located between upper and lower controls, which are able to resize depending on their contents.

Can Publish

Specifies whether or not the control can be printed or exported.

Edit Options

Provides access to define how the content of the control can be edited in the print preview.

Editor Name

Specifies the name of the editor which can be used to change the content of the control in print preview.

Enabled

Specifies if the content of the control can be edited in print preview.

ID

Specifies a unique identifier for the edit options.

Read Only

Specifies if an editor for customizing the content of a control is enabled in print preview.

Image Alignment

Changes the alignment of the image in relation to the control boundaries.

Keep Together

Specifies whether the contents of the control can be horizontally split across pages. In other words, if the control occupies more space than remains on the page, the property specifies whether the control is split between the current page and the next, or printed entirely on the next page. If the control does not fit on the next page either, the control is split, regardless of the property value.

Process Duplicates

Determines the behaviour of the control when the data source contains consecutive repeating records. The records can be processed as is (when the property is set to Leave), suppressed except for the first entry (Suppress) and suppressed with a blank space printed instead of the repeated records (Suppress and Shrink).

Process Null Values

Determines whether to process Null (blank) values if they appear in the control data source. Null values can be processed as is (when the property is set to Leave), suppressed (Suppress) and suppressed with a blank space printed instead of the blank records (Suppress and Shrink).

Scripts

Contains events which can be handled with scripts.

Sizing

Defines the sizing mode of a contained image. The image sizing settings are briefly described in the following table:

Normal

The image is placed in the upper-left corner of the control. The image is clipped if it is larger than the Picture Box which contains it.

Stretch Image

The image within the control is stretched or shrunk to fit the size of a Picture Box.

Auto-Size

The Picture Box size is adjusted to that of the image it contains.

Center Image

The image is displayed in the center of the control. If the image is larger than the Picture Box, the outer edges are clipped.

Zoom Image

The image is sized proportionally (without clipping) for best fit into the control.

Visible

Specifies whether the control is visible when using the print preview.

Data

(Data Bindings)

If the current report is bound to data, the property is used to bind control properties (Bookmark, Image Source, Image URL, Navigation URL and Tag) to a data field obtained from the report data source, and to apply a format string.

Image Source

Specifies an image to display in the picture box control.

Click the ellipsis next to Image Source to display the Open File window, which is used to load the file. This image is then embedded into the report and saved within the report.

Use of this property increases the size of a saved report.To save only the image path, and not the image itself, use the Image URL property.

Image URL

Specifies the URL of the image to display in the Comment Capture control. Both absolute and relative paths are supported. A relative path can be related to a web site or to a web page. In the second case, the path to the image must start with the '~' symbol. Setting a relative path makes it easier to move the entire application to another directory on the server without having to update the code.

Tag

Adds additional information to a control; for example, the Id, by which the control can then be accessed via scripts.

If the current report has a data source, the Tag property can be bound to a data field obtained from the data source. To do this, expand the (Data Bindings) property and from the Tag > Binding drop-down list, select the required data field.

Miscellaneous

(Name)

Determines the name of the control, by which it can be accessed in the Report Explorer, Properties window or via scripts.

Bookmark and Parent Bookmark

These properties are used to create a hierarchical structure within a report called a document map.

If the current report has a data source, the Bookmark property can be bound to a data field, obtained from the data source. To do this, expand the Data > Data Bindings drop-down list and select the required data field.

Navigation URL and Navigation Target

Use the Navigation URL property to specify a URL for web browser navigation when the control is clicked. The web browser displays a page in a window or a frame as specified in the Navigation Target property.

Note: A URL must have an appropriate prefix for example, 'http://'). Cross-references can be created within the report by assigning the name of the target control to the Navigation URL property, and setting the Navigation Target property to ‘_self'.

If the current report has a data source, the Navigation URL property can be bound to a data field obtained from the data source. To do this, expand the Data > Data Bindings drop-down list and select the required data field.

Snap Line Margins

Specifies the margins for the control, which are maintained when the control is aligned using snap lines.

Favorites

Right-click on the Favorites tab and select Edit Favorite Property List to display the Favorite Properties Editor, which is used to customise the available properties on the Favorites tab.

Refer to Conditionally Modify Control Display, Styles Concepts, Handle Events via Scripts, Display Values from a Database (Bind Report Controls to Data), Add Bookmarks und Create Hyperlinks for further information.

In This Topic
TitleResults for “How to create a CRG?”Also Available in