Key issues when automating OyezForms

Launching OyezForms in dotnet

Applications automating OyezForms should use either the oyezfrms.tlb type library file or the OyezV8EZ.ocx control (for early binding), both of which are installed to the application directory. Dotnet programmers who wish to launch OyezForms from a non-form context should use InteropServices to access the .tlb (see example code).

Oyezforms has several dispatch interfaces providing automation, only the OyezAutomation interface should be used by other applications. Only one instance of OyezForms can be created. Only the currently active form can be manipulated. OyezForms does not support a collection of open forms.

Referencing the .OCX control (recommended)

1. In a form's design view, right-click in the 'General' area of the Toolbox panel and select 'Choose Items...'
2. In the 'Choose Toolbox Items' dialog, select the 'COM Components' tab
3. Scroll down the list of components and put a tick next to 'OyezV8EZ', then click 'OK'.
4. The ocx will appear on the Toolbar. Double-click on it to add it to your application's form.
5. In the 'Solution Explorer' tree, a reference named 'AxOyezV8EZ1' will be created.

Referencing the .tlb file using InteropServices (if your project has no form object)

1. Select 'Add reference' in your project.
2. choose 'Browse', and select oyezfrms.tlb (installed to the application folder)
3. using System.Runtime.InteropServices;
   Type OyezAp = Type.GetTypeFromProgID("OyezLegalForms.Application");
   OyezFrms.OyezAutomation oa = (OyezFrms.OyezAutomation)Activator.CreateInstance(OyezAp);
   

Mapping data to OyezForms fields

Data from your application can be inputted into fields on any form after it is created by the new command.

When retrieving label or fieldID lists, you should first specify the page to be interrogated via the .selectpage command.

OyezForms supports descriptive fieldlabels that are stable across pages, form revisions, and within a range of forms. We strongly recommend using fieldlabels as your primary route for mapping data to OyezForms via the .fill command. A list of labels on the current page of a form can be retrieved programmatically via the .labellist command < .labellist().Split(',') >.

As fieldlabels were introduced during the lifetime of OyezForms, a number of less-frequently updated forms do not have fieldlabels. If creating a mapping interface for your users, you should ensure they also have the option to target OyezForms' numeric fieldIDs, using the .fillat command. A list of FieldIDs for the current page can be retrieved programmatically via the .fieldlist property. FieldIDs repeat across pages, and are not stable between form revisions; if extra fields are added to a page, the ID sequence will be reset.

You can find a field label associated with a fieldID by calling .getlabel using a fieldID as parameter.

OyezForms users can see where fieldlabels/fieldIDs appear on any form by selecting Tools>Options>PrintLabels/PrintIDs

Exporting PDFs from OyezForms

The exporttopdf command allows you to save a form as a flattened PDF file. This export cannot be subsequently re-edited, so should be used as an archive, or as a 'for signature' option. The export process is not synchronous, so it may be desirable to check for the task to finish via Actioncomplete.

• oa.exporttoPDF(@"c:\temp\out.pdf");
  while (oa.ActionsComplete() != true)
  {
  System.Windows.Forms.Application.DoEvents();
  }
  

The PDF export facility is based on novaPDF technology and is silently installed in standalone installs. This is also the case in the manual attachment of client PCs to a networked copy of OyezForms (see install help); however, if Active Directory is used with the \setup\setup_AD.msi file to roll out the attachment of client PCs, then the user will need to invoke File > 'Export to PDF' once in order to install the required components.

See also: Configuring OyezForms' PDF engine