Class Form

Readonlyfield

const value = tisa.form.field.myField1.value;
console.log(value);

const { myField1 } = tisa.form.field;
myField1.readOnly = true;
Copy

Readonlygroup

const { G_Supplier } = tisa.form.group;
G_Supplier.hidden = true;
Copy

ReadonlyisDisplayForm

const { form } = tisa;
if (form.isDisplayForm) {
  // your code...
}
Copy

ReadonlyisEditableForm

const { form } = tisa;
const { myField1, myField2, myField3 } = tisa.form.field;
if (form.isEditableForm) {
  // set read-only property for some fields
  myField1.readOnly = true;
  myField2.readOnly = false;

  // set required property for some fields
  myField2.required = true;

  // set value for some fields
  myField3.value = "test";
}
Copy

ReadonlyisEditForm

const { form } = tisa;
if (form.isEditForm) {
  // your code...
}
Copy

ReadonlyisNewForm

const { form } = tisa;
const { myField1, myField2 } = tisa.form.field;
if (form.isNewForm) {
  // copy value of field1 to field2 when it changes
  myField1.onChange((value) => {
    myField2.value = value;
  });
}
Copy

ReadonlyisTaskForm

const { form } = tisa;
if (form.isTaskForm) {
  // your code...
}
Copy

Readonlyprint

const { form } = tisa;

// Open a print template in a new window
await form.print.show("ContractCoverSheet");

// Open with debug box showing all form data
await form.print.show("TestTemplate", true);
Copy

fieldValues

• get fieldValues(): Dictionary<any>

  Gets the values of all fields in the form. The values are stored in a dictionary with the field internal name as the key and the field value as the value.

  Returns Dictionary<any>

  Example

  const { form } = tisa;
  const fieldValues = form.fieldValues;
  console.log(fieldValues);
  Copy

readOnly

• get readOnly(): boolean

  Gets or sets the editability of the form. Locks all editable fields when set to true.

  Returns boolean

  Example

  const { form } = tisa;
  form.readOnly = true;
  Copy

• set readOnly(value: boolean): void

  Gets or sets the editability of the form. Locks all editable fields when set to true.

  Parameters

  • value: boolean

  Returns void

  Example

  const { form } = tisa;
  form.readOnly = true;
  Copy

close

• close(): Promise<void>

  Closes the form.

  Returns Promise<void>

  Example

  console.log("Form is about to get closed");
  await tisa.form.close();
  console.log("This message won't be logged since the form has already been closed.");
  Copy

save

• save(options?: SaveOptions): Promise<boolean>

  Saves the form data.

  By default the form stays open after saving (redirect is false). On a new form, saving without redirect creates the item in SharePoint and automatically switches the form to edit mode — subsequent operations (e.g. starting a workflow) can reference the newly created item.

  Returns true if the form was valid and saved successfully, false if validation failed. Use the return value to conditionally continue after save (e.g. start a workflow).

  Parameters

  • options: SaveOptions = {}

  Returns Promise<boolean>

  true if the form was saved, false if validation failed.

  Example

  // Save and close the form
  await tisa.form.save({ redirect: true });
  // Code here will not execute — the form has already been closed.
  Copy

  Example

  // Save without closing — item is created and form switches to edit mode.
  // Subsequent API calls (e.g. workflow) have access to the new item.
  await tisa.form.save();
  await tisa.workflow.start("Approval");
  Copy

  Example

  // Check if the form is valid before continuing
  const saved = await tisa.form.save();
  if (!saved) return; // form is invalid, stop here
  
  await tisa.workflow.start("Approval");
  Copy

setFormDefinition

• setFormDefinition(name: string): void

  Sets the active form definition by name. The name must match one of the CustomFormDefinitions defined in the form JSON config.

  Can only be called during onFormInit. Throws if called after init or if the name is not found.

  Parameters

  • name: string

    Name of the custom form definition to activate.

  Returns void

  Example

  async function onFormInit() {
    const { form } = tisa;
  
    if (form.isDisplayForm) {
      form.setFormDefinition("DisplayForm");
    } else if (form.isNewForm) {
      form.setFormDefinition("ReceivedMessage");
    }
  }
  Copy

validate

• validate(): Promise<boolean>

  Validates the form data.

  Returns Promise<boolean>

  whether the form data is valid.

  Example

  const formIsValid = await tisa.form.validate();
  
  if (formIsValid) console.log("Form is valid.");
  else console.log("Form is invalid.");
  Copy