API operations related to Sub objects - Intelligent Media Management

This topic describes the API operations that are related to Sub objects of table documents.

Sub.Clipboard_Copy

Listens to Clipboard copy events.

Syntax
expression.Sub.Clipboard_Copy = Function
expression: an Application object.
Return values
Parameter
Type
Description
copyId
String
The ID of the Clipboard.
isRestoreFocus
Boolean
Indicates whether the focus is restored.
text
String
The copied content.

Example

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // Listen to Clipboard copy events.
  app.Sub.Clipboard_Copy = (e) => {
    console.log(e);
  }
}

Sub.Worksheet_Activate

Listens to worksheet activation events.

Syntax
expression.Sub.Worksheet_Activate = Function
expression: an Application object.

Example

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // Listen to worksheet activation events.
  app.Sub.Worksheet_Activate = async () => {
    console.log('ActiveSheet: ', await app.ActiveSheet.Name);
  };
}

Sub.Worksheet_SelectionChange

Listens to selection change events.

Syntax
expression.Sub.Worksheet_SelectionChange = Function
expression: an Application object.

Example

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // Listen to selection change events.
  app.Sub.Worksheet_SelectionChange = (e) => {
    console.log('SelectionChange', e);
  };
}

Sub.Worksheet_ScrollChange

Listens to scroll change events.

Syntax
expression.Sub.Worksheet_ScrollChange = Function
expression: an Application object.

Example

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // Listen to scroll change events.
  app.Sub.Worksheet_ScrollChange = () => {
    console.log('ScrollChange');
  };
}

Sub.Window_Blur

Listens to window blur events.

Important

Only the SDK for JavaScript V1.1.10 and later support this feature.
The feature applies only to PCs.

Syntax
expression.Sub.Window_Blur = Function
expression: an Application object.

Example

async function example() {
  await instance.ready();

  const app = instance.Application;

  // Listen to window blur events.
  app.Sub.Window_Blur = () => {
    console.log ('Window blur');
  };
}

Sub.Window_Focus

Listens to window focus events.

Important

Only the SDK for JavaScript V1.1.10 and later support this feature.
The feature applies only to PCs.

Syntax
expression.Sub.Window_Focus = Function
expression: an Application object.

Example

async function example() {
  await instance.ready();

  const app = instance.Application;

  // Listen to window focus events.
  app.Sub.Window_Focus = () => {
    console.log ('Document focus');
  };
}

Sub.User_Join

Listens to collaborator joining events.

Syntax
expression.Sub.User_Join = Function
expression: an Application object.

Example

async function example() {
  await instance.ready();

  const app = instance.Application;

  // Listen to collaborator joining events.
  app.Sub.User_Join = (e) => {
    console.log ('A user joins online collaboration: ', e);
  };
}

Sub.User_Quit

Listens to collaborator exiting events.

Syntax
expression.Sub.User_Quit = Function
expression: an Application object.

Example

async function example() {
  await instance.ready();

  const app = instance.Application;

  // Listen to collaborator exit events.
  app.Sub.User_Join = (e) => {
    console.log ('A user quits online collaboration:', e);
  };
}

Sub.Version_Change

Listens to document version change events.

Syntax
expression.Sub.Version_Change = Function
expression: an Application object.

Example

async function example() {
  await instance.ready();

  const app = instance.Application;

  // Listen to document version change events.
  app.Sub.Version_Change = (e) => {
    console.log ('Document version changes: ', e);
  };
}

Sub.CollapseHeader

Listens to toolbar collapse actions.

Syntax
expression.Sub.CollapseHeader = Function
expression: an Application object.
Return values
Parameter
Type
Remarks
type
Boolean
true if the toolbar is collapsed. false if the toolbar is expanded.

Example

async function example() {
  await instance.ready();

  const app = instance.Application;
  
  // Call the toolbar collapse function.
  app.Sub.CollapseHeader = (e) => {
    console.log("Collapsed or expanded: ", e.type);
  }
}

Parameter	Type	Description
copyId	String	The ID of the Clipboard.
isRestoreFocus	Boolean	Indicates whether the focus is restored.
text	String	The copied content.

Parameter	Type	Remarks
type	Boolean	true if the toolbar is collapsed. false if the toolbar is expanded.