Configure a Web Capture control

Configure the Web Capture control to:

Selectively hide specific buttons at design time and only display the selected ones at runtime.
Customize the icons used to match the look and feel of your site. The icons reflect the image provided at the design time. If you do not provide an image, a red X appears next to the button.
Prevent users from editing (moving, resizing, deleting, changing text).

When you add a Web Capture control, the Web Capture control toolbar appears at runtime.

The following table describes the buttons available on the Web Capture control toolbar:

Button Name	Icon	Description
File Upload		Displays the Import button. Use this button to upload a file at runtime. Note When you enter a static document ID, the system creates a new document and disables the Enable Scanning and Import options at runtime. TotalAgility supports all image types and PDFs but does not support annotations in PDFs.
Add Page from File		Adds pages by importing file from your local computer.
Save		Optional. Saves the scanned pages.
Enable Scan		Use this button to scan images. Note For the first time, the system prompts you to install the scanner.
Select Scanner		Displays a list of scanners to choose from.
Scan		Scans pages using the selected scanner.
Add Page from Scanner		Adds pages to the existing scanned pages.
Previous Page		Displays the Previous Page button. Use this button to go to a previous page.
Page Counter		Displays the page counter label that displays the index of the current page. Note For example, in a 6-page document, if page 3 is the current page, the index is displayed as 3/6.
Next Page		Displays the Next Page button. Use this button to go to the next page.
Delete Page		Displays the Delete Page button. Use this button to delete pages that have been incorrectly scanned. Clicking this button displays a confirmation message, "Are you sure you want to delete page x of y". (x is the current page and y is the total pages). Once confirmed, the selected page is deleted. The index of the pages updates accordingly.
Zoom In		Displays the Zoom In button. Use this button to magnify the view.
Zoom Out		Displays the Zoom Out button. Use this button to constrict the view.
Full Size		Displays the Full Size button. Use this button to view the image at its real size.
Best Fit		Displays the Best Fit button. Use this button to fit the entire image to the viewer.
Fit to Width		Displays the Fit to Width button. Use this button to fit the image to the width of the viewer.
Draw Highlight		Displays the Draw Highlight button. Use this button to highlight the text.
Draw Line		Displays the Draw Line button. Use this button to draw a line.
Draw Freehand		Displays the Draw Freehand button. Use this button to create freehand annotation.
Draw Redaction		Displays the Draw Red button. Use this button to create redaction annotation.
Draw Text		Displays the Draw Text button. Use this button to create text annotation.
Page Up		Displays the Move Up button. Use this button to move the current page up. If you try to move the first page up, a warning message appears.
Page Down		Displays the Move Down button. Use this button to move the current page down. If you try to move the last page down, a warning message appears. Note Moving the page up or down, updates the page index accordingly. For example, in a 6-page document, if page 3 is the current page and you move this page up, the current page moves to page 2. The index for this page displays page 2 of 6.
Undock		Undocks the document viewer from the main form and displays in a separate browser window so that it can be viewed on a second monitor. Undocking document viewer helps in viewing the image or document on one screen while completing out the form on the other screen. For example, you can view the image of invoice on one screen while completing the other details in the form on the second screen. Note The inner size of the undocked image viewer in the new browser window matches the size of the original Web Capture control. The Undock button is hidden in an undocked document viewer. When the undocked image window is closed, the image reappears on the main form as docked (original form). By default, the Undock button is hidden for upgraded forms. You can set the button in the Designer to display at runtime.
Help		Use this button to navigate to help.

By default, the Web Capture control displays all buttons at runtime. To restrict a button from displaying at runtime, select the button from the table and click No for Show Button. For example, to restrict the Import button from displaying at runtime, select File Upload from the table and click No for Show Button.

Note If you hide all the buttons, the toolbar is not displayed at runtime.
By default, a button has a specific image. To display a different image for the button:
1. Select the button.
2. Select either option for Load Image from Store:
  1. No: Enter an image name or URL in the Image box.(Default: No)
    Note For on-premise TotalAgility, the image needs to reside in <Installation location>\Kofax\TotalAgility\Agility.Server.Web\Forms\Images.
  2. Yes: Consume an existing image or enter the image name (for example, Add.png) in the Image box.
    
    Note the following:
    - The name must match the name in the database for the image to display at runtime.
    - TotalAgilitysupports all image types.
Click Yes for Show Button to edit the following annotation (Default: Yes):
- Highlight
- Redaction
- Freehand
- Text
- Line
Note If Show Button is set to the following:
- Yes: Allows to add and edit.
- No: The Allow Edit button is displayed. You can specify whether to edit or not.
Consume a Folder Type.

This folder type is used when creating a new folder. If you do not specify the folder type, the Web control uses the default folder type.
Consume a Document Type.

This document type is used when creating a new document. If you do not specify the document type, the Web control uses the default document type.
Consume a global variable, form variable or a form field to store the returned folder ID or enter a static value in the Folder ID box. If you enter a static document ID, the system creates a new document.
Note the following:
- If the document ID field is mapped to a variable, control or to inline with a value, the folder ID value is not used.
- If the folder ID is mapped to a variable, control or to inline with a value, a new document is created in that folder and the document ID variable or control is set to its ID.
- If the folder ID is mapped to a variable or control without a value, a new folder and new document are created and both variables or controls are set to their respective IDs.
- You can consume the Folder ID property of the control in an event.
Consume a global variable, form variable or a form field to store the returned Document ID or enter a static value.

If you enter a static document ID, the system creates a new document.
Consume a Scan/VRS Profile to scan the document. If you leave this property empty, the control uses the default Scan/VRS profile.
Select either PNG or JPG for Display Image Format.
To allow rendering the electronic documents so that they can be viewed in TotalAgility forms, click Yes for Enable eDoc Rendering. (Default: No)

Note eDocs refer to Microsoft office and PDF documents.
Click Save.

Display page counter outside of Web Capture Control toolbar

You can display the page counter outside of Web Capture control toolbar, anywhere on the form, using the WebCaptureControl.PageCounter property of the Web Capture control.

In the Form Designer, add a label to a form.
Display the value of WebCaptureControl.PageCounter in this label.
Add the PageIndexChanged event to notify the system that page counter label should be updated whenever the page index changes.
Use an action, such as Same page, bound to the PageIndexChanged event to update the text of the label with the new page counter value.

Your search for {searchVal} returned {total} results.

Configure a Web Capture control

Display page counter outside of Web Capture Control toolbar