TreeINFO-For-M365 documentation
    Preparing search index...

    Class Form

    Hierarchy

    • BaseService<FormCustomizerContext>
      • Form

    Implements

    Index

    Constructors

    constructor

    Properties

    field isDisplayForm isEditableForm isEditForm isNewForm isTaskForm methods

    Accessors

    disableWaitDialog fieldValues readOnly

    Constructors

    • Parameters

      • serviceContext: ServiceContext<any>
      • methods: IFormServiceMethods
      • fields: ISPFieldBase[]

      Returns Form

    Properties

    field: Dictionary<IFieldService>

    Accesses the form field object

    const fValue = tisa.form.field.myField1.value;

    const { myField1 } tisa.form;
    myField1.readOnly = true;
    isDisplayForm: boolean

    True if the form does not allow editing of the item

    isEditableForm: boolean

    True if the form allows fields to be filled in. The "isEditableForm" property matches the condition ("isNewForm" or "isEditForm")

    const { form } tisa;
    const { myField1, myField2, myField3 } tisa.form;
    if (form.isEditableForm){
      myField1.readOnly = true;
      myField2.readOnly = false;
      myField2.required = true;
      myField3.value = "test";
    }
    isEditForm: boolean

    True if the form allows editing of the item

    isNewForm: boolean

    True if the item does not yet exist and the form allows filling in its metadata

    const { form } tisa;
    const { myField1, myField2 } tisa.form;
    if (form.isNewForm){
      // copies the value of field1 when changed to field2
      myField1.onChange((value)=>{
        myField2.value = value;
      });
    }
    isTaskForm: boolean

    True if the form displays a task to complete

    methods: IFormServiceMethods

    Accessors

    • get disableWaitDialog(): boolean

      Disables automatic display of the wait dialog for asynchronous operations

      Returns boolean

    • set disableWaitDialog(value: boolean): void

      Disables automatic display of the wait dialog for asynchronous operations

      Parameters

      • value: boolean

      Returns void

    • get fieldValues(): Dictionary<any>

      Returns Dictionary<any>

    • get readOnly(): boolean

      Gets or sets the editability of the form. Locks all editable fields.

      Returns boolean

    • set readOnly(value: boolean): void

      Gets or sets the editability of the form. Locks all editable fields.

      Parameters

      • value: boolean

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors