The validation form can be accessed directly or via the validation pane and has the following customizable properties:

ActiveTab

Returns the currently-displayed tab of the validation form for the selected document. For Thin Clients this status property may return an unpredictable value during the DocumentLoaded event.

ActiveTabIndex

Returns the index (zero-based) of the current tab. For Thin Clients this status property may return an unpredictable value during the DocumentLoaded event. This property is read-only and cannot be changed.

Note When the folder tab is active in one of the Thin Client modules, the ActiveTabIndex is set to a value of -1.

Buttons

Returns the collection of all buttons defined for the validation form, the tabs or groups. The button collection of the validation form object contains all buttons independent from their location whereas the button collection for a tab contains only those buttons that are located on a specified tab and similarly for validation pane and group. You can customize the properties of a specific button.

ClassName

Returns the name of the class the currently-selected document is assigned to. This property is read-only and cannot be changed.

CurrentPageIndex

Returns the index of the currently-selected page. For Thin Clients this status property may return an unpredictable value during the DocumentLoaded event. This property is read-only and cannot be changed.

DocViewer

Returns the script document viewer control.

FieldLabels

Returns the collection of all field labels defined for the validation form or pane, the tabs or groups. The field label collection of the validation form object contains all field labels independent from their location whereas the field label collection for a tab contains only those field labels that are located on a specified tab and similarly for validation pane and group. You can customize the properties of a specific field label.

Fields

Returns the collection of all extraction fields defined for the validation form or pane, the tabs or groups. The field collection of the validation form object contains all fields independent from their location whereas the field collection for a tab contains only those fields that are located on a specified tab and similarly for validation pane and group. You can customize the properties of a specific field.

Groups

Returns the collection of all groups defined on the validation form or tab. The group collection of the validation form object contains all groups independent from their location whereas the group collection for a tab contains only those groups that are located on a specified tab and similarly for validation pane. You can customize the properties of a specific group.

Labels

Returns the collection of all labels defined on the validation form, validation pane, tabs or groups. The label collection of the validation form object contains all labels independent from their location whereas the label collection for a tab contains only those labels that are located on a specified tab and similarly for validation pane and group. You can customize the properties of a specific label.

MaskedAreas

Returns the collection of masked areas of the validation form where the masked area are selected by their index. You can define static masked areas on the validation form using the validation form layout designer or masked areas that are created via script. You can customize the properties of a specific masked area.

Important In general it is best practice to either use static masked areas that are defined via the validation form layout designer or masked areas created via script. The reason is that in order to handle masked areas in script in the DocumentLoaded event correctly you have to delete all existing masked areas and then create new areas again. Hereby, the deletion removes all kinds of masked areas, static or script-created ones. Without removing the masked areas prior to creating new ones you may end up having various loaded masked areas at the same coordinates, which then overlay each other.

The masked area collection provides the following methods and properties:

Count As Long

Returns the number of masked areas in the collection. This property is read-only and cannot be changed.This is a read-only property.

ItemByIndex(ByVal Index As Long) As CscScriptMaskedArea

Returns a certain masked area object by zero-based index. This property is read-only and cannot be changed.

Create() As CscScriptMaskedArea

Creates a new masked area object and adds it to the collection. The new masked area object is returned.

Remove(ByVal Index As Long)

Removes the masked area object from the collection at the given zero-based index.

 ' First step deletes already created masked areas   
   Dim i As Integer
   For i = ValidationForm.MaskedAreas.Count - 1 To 0 Step -1
      ValidationForm.MaskedAreas.Remove(i)
   Next
   ' Second step: creates a masked area
      Dim maskedArea As CscScriptMaskedArea
      Set maskedArea = ValidationForm.MaskedAreas.Create
      maskedArea.Height = 1000
      maskedArea.Left = 100
      maskedArea.Top = 100
      maskedArea.Width = 1000
      maskedArea.PageIndex = 0

Important For Thin Client Validation you have to define one static masked area for the validation form layout designer to ensure that documents are not loaded without showing masked areas that are defined via script. When a static masked area is defined this influences the loading process and ensures that the document is displayed in the viewer after the masked areas are created. Therefore the size and position of this static masked area is not relevant.

MiniViewers

Returns the collection of all mini viewers defined on the validation form, tabs or groups. The miniviewer collection of the validation form object contains all miniviewers independent from their location whereas the miniviewer collection for a tab contains only those that are located on a specified tab and similarly for groups. You can customize the properties of a specific mini viewer.

Tables

Returns the collection of all table fields defined on the validation form or tabs. The table collection of the validation form object contains all tables independent from their location whereas the table collection for a tab contains only those that are located on a specified tab. You can customize the properties of a specific table field.

Tabs

Returns the collection of all tabs defined on the validation form. You can customize the properties of a specific tab.

ValidationPanel

Returns the ValidationPanel object that contains the folder field area - only available when foldering is enabled.