Open a Report, Label or Letter layout

Description

Displays a report, label or letter layout as a PDF file using the Acrobat PDF reader. The report is displayed in either a pop-up window or in a DIV on the current page.

Used with the Grid and UX component

 Javascript

{grid.componentName}_G_ACTIONBUTTON_1(this);

 Layout Print Definition Properties

Report name

Specify the report (Report, Label or Letter) name.

Initial view

Specify if the report should be rendered as as a PDF document, or as HTML. (For best performance, HTML is recommended for 'Layout Table' reports). IMPORTANT: The 'HTML' option is NOT SUPPORTED for 'Letters', 'Labels' and 'Reports' that are not designed using the 'Layout Table' editor. Choices include PDF, HTML, HTML-Paged.

Filter

Specify if the report should be filtered. (This filter is in addition to any filter that was defined as part of the report layout).

Order

Specify the report order. If you specify an order here it will override the order defined in the report layout.

SQL Filter

Specify if the report should be filtered. This filter must be defined using SQL syntax. It is executed on the Database Server. (This filter is in addition to any filter that was defined as part of the report layout).

SQL Order

Specify the report order. If you specify an order here it will override the order defined in the report layout.

Local Filter

The local filter is executed after the data is retrieved from the SQL database. This filter must be specified using Xbasic syntax. If possible, you should use a SQL Filter in preference to a Local Filter - it is much more efficient.

Local Order

The local order is applied after the data is retrieved from the SQL database. This order must be sepecified using Xbasic syntax.

PDF Options

PDF Options property.

Local argument definitions

Local argument definitions property.

Argument bindings

Argument bindings property.

PDF open parameters

Specify parameter to control how the PDF is displayed when it is intially rendered. You can set properties such as the zoom level. Not all PDF readers support these properties.

 HTML Report Viewer Options Properties

Print as PDF

Show a button on the HTML Report viewer to make a callback and render the report as a PDF document.

Export to Excel

Show a button to export the Report to Excel

Export to Word

Show a button to export the Report to Word

Export to Text

Show a button to export the Report to text file

Print

Show a button to print the HTML report.

Report Bookmarks button type

If the report you are viewing has bookmarks, the bookmarks are shown in a Panel. If the report container is too narrow to show the Bookmarks Panel, the Panel is automatically collapsed, and a button is shown to display the Bookmarks Panel. Specify the button style. Choices include Text, Image.

Report Bookmarks button text

Specify the text for the Bookmarks button.

Report Bookmarks button image

Specify the text for the Bookmarks button.

Report Bookmarks panel width

Specify the width for the Bookmarks Panel. Use CSS syntax (not %). If there is insufficient space to show the Panel, it will be automatically collapsed and can then be shown by clicking on the Bookmarks button.

Maximum records to display

Specify the maximum number of records to display in the HTML report. Enter 0 to see all records. Limiting the number of records will allow the report to display faster.

'More records' message

Specify the message to show if there are more records in the report than the number in the display limit. The mnessage will not show if the total records in the report is less that the number set in the display limit. [DisplayRecords] is a placeholder for the number of records to display. [TotalRecords] is a placeholder for the total number of records in the report.

'More records' message container style

Specify the in-line style for the container that holds the 'More records' message.

 Target Window, DIV, Tabbed UI Pane or Panel Properties

Target

Specify if the report should be opened in a pop-up window, a DIV on the page, a Panel or (if the component is running in a Tabbed UI) in a new Tabbed UI pane. (If you choose the 'Tabbed UI Pane' option, and the component is not running inside a Tabbed UI, it will be opened in a modeless pop-up window). Choices include.

Target Panel

Specify the Panel Id.

Target DIV ID

Specify the ID of the target DIV. This DIV can be in the Grid component (for example, in a free-form edit region), or on the .a5w page that contains the Grid component. TIP: If you want to specify a DIV that is inside a freeform edit region in a Grid cell, use the '{grid.rowID}' placeholder in the DIV id. For example: 'div1_Row{grid.rowID}'. This will ensure that each row has a uniquely named DIV in which the target page can be displayed.

Parent Panel Navigator

Specify the Id of the parent Panel Navigator. The dynamic Panel will be added to this Panel Navigator.

Dynamic Panel Title

Specify the title for the Dynamic Panel.

User can close dynamic panel

(Only applies if the target Panel Navigator has been configured to use a Tab Band) Specify if the label for the dynamically added Panel has a 'close' icon that allows the user to close the dynmically added Panel.

Working message placement

Specify the panel where the wait message should be shown. You should chose a Panel that is currently visible, not a Panel that will be animated into view when the component is rendered.

Working message uses CSS3 animation?

Specify if the working message should be displayed using a CSS3 animation?

Working message animation size

Specify the size of the animation in pixels.

Can hide target DIV?

Specify the DIV can be hidden (to remove from view the target page after it has been opened in the DIV).

DIV hide hyperlink

Specify text for the hyperlink that hides the DIV where the target page is shown.

Target IFrame style

The target page will be opened in an IFrame inside the target DIV. Specify the inline style for the IFrame. You can set the IFrame's height and width in the style.

Report height

Specify the height of the report. The report container DIV will be resized to this height. Use CSS units.

Report width

Specify the width of the report. The report container DIV will be resized to this height. Use CSS units.

Window name

Set to <Default> to give the window a default name. If you give the window an explicit name (which must be unique), then you can easily get a pointer to the window to execute methods of the window object. Click the smart field for tips on how to name your window and for information on how to get a pointer to the window object.

Window type

Specify the window type. Popup windows will show in a moveable window on the page. Dropdown windows have no title bar and cannot be moded. By default, Dropdown windows open directly below the control that you click to open the window. Note: An Ajax window will NOT be blocked by a browser's internal protection against popup windows.

Lock overlay CSS class name

Specify the CSS class name to use for the overlay that is displayed behind the window. The overlay prevents the user from clicking on controls that are outside the window. Leave blank, or specify <Default> to use the default style. Specify <Invisible> to create an invisible overlay (has no color, but user is still prevented from clicking on controls off the window). By specifying a class that has a 'background' attribute, you can control the color of the overlay. For example: background: rgba(0,0,0,0) to create a transparent overlay.

Sub-theme

(Optional) Specify a sub-theme for the window. The sub-theme can select a different pre-defined window 'look'. If you leave this property blank the 'base' sub-theme is automatically selected.

Dock window

Docked windows 'stick' to an edge of the screen and remain in place even when the page is scrolled.

Dock location

Specify which edge of the screen the window is docked to. Choices include Left, Right, Top, Bottom.

Window position

Specify where the window will be shown.

Re-use existing window

Specify if multiple modeless windows can be opened, or only a single modeless window.

Window title

Specify the window title. The window title can contain data from fields in the current record. Enclose field values in curly parens. e.g. Customer - {lastname}. To reference values from a column in a List control use this syntax: {LIST::ListName::ColumnName} (e.g. {LIST::MYLIST1::LASTNAME} )

Window title show

Specify if the window title should be shown or hidden.

Window title position

Specify if the window title should appear at the top or bottom of the window. Choices include Top, Bottom.

Window title direction

Specify if the direction is 'ltr' (left-to-right) (title on left, close button on right) or 'rtl' (right-to-left) (close button on left and title on right). Choices include ltr, rtl.

Window title has close button

Specify if the window title has a Close button.

Disable window move

Specify if the window cannot be moved by the user.

Pane title

Specify the tab pane title. The pane title can contain data from fields in the current record. Enclose field values in curly parens. e.g. Customer - {lastname}. To reference values from a column in a List control use this syntax: {LIST::ListName::ColumnName} (e.g. {LIST::MYLIST1::LASTNAME} )

Window height

Specify the window height. Use CSS syntax. For example: 3in, 10cm, 200px. If you do not set the height, the window will resize automatically to accommodate the window contents.

Window width

Specify the window height. Use CSS syntax. For example: 3in, 10cm, 200px. If you do not set the width, the window will resize automatically to accommodate the window contents.

Window is resizable

Specify if the window is resizable.

Working message

Specify the text of the message to show in the window while the window waits for its contents to be generated. You can use this placeholder in the message: {reportName}

Working message icon

Specify the image to show in the window while the window waits for its contents to be generated.

Client-side file name

Specify the default filename on the user's computer (when they download the file). If you leave this blank, the filename of the server will be used as the default client-side filename.

Xbasic function

Specify the name of the Xbasic function to call after the report has been created.

DIV Id for progress messages

Specify the ID of a DIV where the 'working...' message, and any error messages, should be shown. This DIV can be in the Grid component (for example, in a free-form edit region), or on the .a5w page that contains the Grid component. TIP: If you want to specify a DIV that is inside a freeform edit region in a Grid cell, use the '{grid.rowID}' placeholder in the DIV id. For example: 'div1_Row{grid.rowID}'. This will ensure that each row has a uniquely named DIV in which the messages can be displayed.

Has pointer icon

Specify if the window has a pointer icon that points to the element that was clicked to show the window.

Pointer position

Specify the window edge that has the pointer icon. If you select 'Auto' the most appropriate edge is automatically selected. Choices include Auto, Top, Bottom, Left, Right.

 Window Buttons Properties

Has custom toolbar buttons

Specify if the window has custom buttons in the window toolbar (at the bottom of the window).

Define buttons

Define the buttons that appear in the window toolbar (at the bottom of the window).

Buttons in-line style

In-line style for the buttons. TIP: To display the buttons left justified, enter an in-line style of: text-align:left;

 Optional Window Parts Properties

Show top bar

Specify if a top bar should be shown. (Shows above the window body, but inside the body container).

Top bar HTML

Specify the HTML to show in the top bar.

Top bar style

Specify the in-line style for the top bar.

Show bottom bar

Specify if a top bar should be shown. (Shows below the body, inside the body container).

Bottom bar HTML

Specify the HTML to show in the top bar.

Bottom bar style

Specify the in-line style for the top bar.

Show header

Specify if a header should be shown. (Shows above the window body, but inside the body container).

Header HTML

Specify the HTML to show in the header.

Header style

Specify the in-line style for the top bar.

Show footer

Specify if a footer should be shown. (Displays below the body, the bottom bar and below any user-defined buttons).

Footer HTML

Specify the HTML to show in the footer.

Footer style

Specify the in-line style for the footer.

 Client-side Events Properties

Before execute event

Specify the name of a Javascript function to call before the callback is made to open the target Report. This Javascript function will take 'ro' as an input parameter. 'ro' contains all of the settings for the target Report to be opened. The purpose of this function is to allow you to override any of the properties of the passed-in 'ro' object.

After execute Javascript

Specify the Javascript code to run after the Report has been printed.

 Window Animation Properties

Animation

Specify if the window should be animated when it is shown or hidden. Note: If the window contains an IFrame, which in turn contains a PDF viewer, animation may not work well and should not be used.

Show animation style

Select the animation method to use when the window is shown. Fade and Slide use methods in jQuery core. Other options require jQueryUI.

Show animation speed

Specify the animation speed. You can select a pre-defined option (slow = 600 milliseconds, fast = 200 milliseconds), or you can enter an explicit value in milliseconds.

Hide animation style

Select the animation method to use when the window is closed. Fade and Slide use methods in jQuery core. Other options require jQueryUI.

Hide animation speed

Specify the animation speed. You can select a pre-defined option (slow = 600 milliseconds, fast = 200 milliseconds), or you can enter an explicit value in milliseconds.

 Window Javascript Events Properties

onInitialize

Specify the Javascript code to execute the first time the window is shown.

onBeforeShow

Specify the Javascript code to execute before the window is shown.

onShow

Specify the Javascript code to execute when the window is shown.

onBeforeHide

Specify the Javascript code to execute before the window is hidden.

onHide

Specify the Javascript code to execute when the window is hidden.

onFocus

Specify the Javascript code to execute when the window gets focus.

onMove

Specify the Javascript code to execute when the window is moved.

onResize

Specify the Javascript code to execute when the window is resized.

 Ajax Failed/Offline Javascript Properties

Offline Javascript

(Optional) Specify the Javascript to execute if the device is offline. Since the device is offline, the Ajax callback is not made. Therefore the code in the 'Ajax failed Javascript' property will not get executed.

See Also