Skip navigation FileNet logo
  Open Client Developer's Guide
  Search  |  Index  |  Glossary   |  
Open menu Overview
Close menu Open Client Architecture
  Project Directory Structure
  Close menu Developing ASPX Pages
    ASPX Page Guidelines
    Code-Behind File Guidelines
    Open Client Guidelines
  Open menu User Interface Controls
  Open menu Data Provider
Open menu Developing for Process
Open menu Error and Exception Handling
Open menu Customizing the Framework
Globalization / Localization
Open menu General Information
   

Guidelines for Creating the ASPX Code-Behind File

The following general guidelines apply when creating an .aspx.vb code-behind file for Open Client:

  • Do imports in the code-behind file. Import all relevant global system, Web, HTML, XML, etc.-related classes. For example:

    Option Strict Off
    Imports System.Drawing
    Imports System.Web
    Imports System.Web.UI.WebControls
    Imports System.Web.UI.HtmlControls
    Imports System.Xml
    Imports System.Threading

  • Import all relevant system globalization, Data Provider, preferences, utility, application, etc.-related classes. For example:

    Imports System.Globalization
    Imports <Your Open Client directory>.FnDataProvider
    Imports <Your Open Client directory>.FnDataProviderData
    Imports <Your Open Client directory>.FnNavigation
    Imports <Your Open Client directory>.FnPreferences
    Imports <Your Open Client directory>.FnUtil
    Imports <Your Open Client directory>.FnApplication

  • Unless you are customizing from scratch, it is simpler to define an applet class that inherits the standard system page UI. For example (to specify a class to implement a Process HTML Step Processor main page):

    Public Class FnStepProcessor
    Inherits System.Web.UI.Page

  • Certain function calls, such as initializing components, are required by the Web Form Designer as they appear in the out-of-the-box source code and should not be edited. For example:

    Private Sub Page_Init(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles MyBase.Init
    'CODEGEN: This method call is required by the Web Form Designer
    'Do not modify it using the code editor.
    InitializeComponent()
    End Sub

  • Customize the ASPX file and its code-behind .aspx.vb file according to your business requirements. Customization can range from relatively simple changes that modify the "look and feel" of the out-of-the-box HTML Step Processor to more complex changes that modify the layout and controls for specific business logic requirements, to even more extensive changes involving content integration, accessing different data sources, modifying access (for example, by hiding controls), making authentication changes, and so on.

  • Use the Open Client VB.NET-based User control .ascx files and their associated .ascx.vb code-behind files to customize your user interface. User Controls are reusable object-oriented, event-driven controls that use the .ascx extension. User Controls can be loaded into ASPX pages or into other User Controls. You may use and reuse these controls in conjunction with the .NET server controls (and associated .NET classes) to provide the presentation layer (the "View" part of the MVC model) that provides the user interface. Open Client User Controls (the file names are fairly self-explanatory) include controls for attachments, plug-ins, a base User control class, data fields, general info, milestones, reassignments, workgroups, and so on.

  • Use the appropriate Data Provider classes to provide specific user interface functionality, such as using the FnProcessStepProcDP for an HTML Step Processor, and so on. Remember to import the appropriate system controls and base Data Providers so these classes can inherit them. For example, if you are creating a customized HTML Step Processor, you will likely want to import the FnProcessBaseDP base Process Data Provider abstract class (inherits FnBase). Note that some of the Data Provider classes also include Open Client wrapper classes to provide Open Client-related functionality, such as setting an FnProcessSession object to a VWSession object, and so on.)