Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Constructors

constructor

  • new FormDefinitionInterface(xmlString?: string, inputData?: any, inputGeometry?: Geometry): FormDefinitionInterface
  • Initializes a new instance of the {@link geocortex.forms.FormDefinition} class.

    class

    Represents a workflow form.

    constructs

    Parameters

    • Optional xmlString: string

      The xml of the form definition in a string.

    • Optional inputData: any

      The dictionary of DataItem collection.

    • Optional inputGeometry: Geometry

      The geometry to use for filtering the entries in the list box.

    Returns FormDefinitionInterface

Properties

containerFormItem

containerFormItem: any

The container form item.

type

ContainerFormItem

Private createElementDelegate

createElementDelegate: function

Type declaration

    • (XMLDocument: any, FormDefinition: any): FormItem
    • Parameters

      • XMLDocument: any
      • FormDefinition: any

      Returns FormItem

inputData

inputData: any

The dictionary of collection of DataItem to be used when binding form items that derive from DataItemsFormItem, such as ComboBoxFormItem and ListBoxFormItem.

type

Object

inputGeometry

inputGeometry: Geometry

The input geometry that can be used to filter the queries in the ComboBox and ListBox.

type

esri.geometry.Geometry

knownTypes

knownTypes: string[]

The known types used by this form definition.

type

String[]

maxHeight

maxHeight: Observable<number>

The maximum height of the form (in pixels).

type

number

maxWidth

maxWidth: Observable<number>

The maximum width of the form (in pixels).

type

number

title

title: Observable<string>

The title of the form.

type

String

version

version: number

The Form Definition Language version.

type

String

Methods

addCascading

  • addCascading(cascadingId: string, formItem: FormItem, handler: Function): void
  • Adds a cascading relationship. The FormDefinition will satisfy these relationships after it loads all controls by attaching the supplied handler to the cascading event of the specified control.

    Parameters

    • cascadingId: string

      The id of the control that supports cascading.

    • formItem: FormItem

      The form item.

    • handler: Function

      The handler that will be triggered when an item cascades.

    Returns void

destroy

  • destroy(): void
  • Destroy all the form ui dijits that were created.

    Returns void

getFormItemById

  • getFormItemById(itemId: string): FormItem
  • Get the contained FormItem with the given id or null if none can be found.

    Parameters

    • itemId: string

    Returns FormItem

getResults

map

  • Adds a control entry that allows the FormDefinition to quickly find the control by its ID.

    Parameters

    Returns void

render

  • Renders a form and attaches it to the dom node. This method should be overridden in the viewer.

    Parameters

    Returns void

validate