Type Alias: HandlersSettings

type HandlersSettings = object;

Properties

onAfterCreate()?

optional onAfterCreate: () => void;

A handler that is called when create is complete

Returns

void

Examples

// ESM usage
import { arWebDesigner } from './web-designer.js';
arWebDesigner.create('#ar-web-designer', {
	documents: {
       handlers: {
          onAfterCreate: () => {
				console.log('New report created successful.')
			}
      }
	}
});

// UMD usage
GrapeCity.ActiveReports.Designer.create('#ar-web-designer', {
	documents: {
       handlers: {
          onAfterCreate: () => {
				console.log('New report created successful.')
			}
      }
	}
});

GrapeCity.ActiveReports.Designer.create('#ar-web-designer', {
	documents: {
       handlers: {
          onAfterCreate: () => {
				console.log('New report created successful.')
			}
      }
	}
});

---

onAfterOpen()?

optional onAfterOpen: () => void;

A handler that is called when open is complete

Returns

void

Examples

// ESM usage
import { arWebDesigner } from './web-designer.js';
arWebDesigner.create('#ar-web-designer', {
	documents: {
       handlers: {
           onAfterOpen: () => {
				console.log('New report opened successful.')
			}
       }
	}
});

// UMD usage
GrapeCity.ActiveReports.Designer.create('#ar-web-designer', {
	documents: {
       handlers: {
           onAfterOpen: () => {
				console.log('New report opened successful.')
			}
       }
	}
});

GrapeCity.ActiveReports.Designer.create('#ar-web-designer', {
	documents: {
       handlers: {
           onAfterOpen: () => {
				console.log('New report opened successful.')
			}
       }
	}
});

---

onAfterSave()?

optional onAfterSave: (info) => void;

A handler that is called when save is complete

Parameters

info

SaveDocumentInfo

Returns

void

Examples

// ESM usage
import { arWebDesigner } from './web-designer.js';
arWebDesigner.create('#ar-web-designer', {
		documents: {
			fileView: {
		handlers: {
			onBeforeSave: (info) => {
				return new Promise((resolve, reject) => {
					resolve(false);
				});
			}
		}
});

// UMD usage
GrapeCity.ActiveReports.Designer.create('#ar-web-designer', {
	documents: {
		handlers: {
			onAfterSave: (info) => {
				if (!info.success) throw new Error(`Report saving error`);
			}
		}
	}
});

GrapeCity.ActiveReports.Designer.create('#ar-web-designer', {
	documents: {
		handlers: {
			onAfterSave: (info) => {
				if (!info.success) throw new Error(`Report saving error`);
			}
		}
	}
});

---

onBeforeCreate()?

optional onBeforeCreate: () => Promise<boolean>;

An async handler, cancels create process if returned false

Returns

Promise<boolean>

Examples

// ESM usage
import { arWebDesigner } from './web-designer.js';
arWebDesigner.create('#ar-web-designer', {
	documents: {
       handlers: {
           onBeforeCreate: () => {return false}
       }
	}
});

// UMD usage
GrapeCity.ActiveReports.Designer.create('#ar-web-designer', {
	documents: {
       handlers: {
           onBeforeCreate: () => {return false}
       }
	}
});

GrapeCity.ActiveReports.Designer.create('#ar-web-designer', {
	documents: {
       handlers: {
           onBeforeCreate: () => {return false}
       }
	}
});

---

onBeforeOpen()?

optional onBeforeOpen: () => Promise<boolean>;

An async handler, cancels opening process if returned false

Returns

Promise<boolean>

Examples

// ESM usage
import { arWebDesigner } from './web-designer.js';
arWebDesigner.create('#ar-web-designer', {
	documents: {
       handlers: {
			onBeforeOpen: () => {
				return new Promise((resolve, reject) => {
					resolve(false);
				});
			}
       }
	}
});

// UMD usage
GrapeCity.ActiveReports.Designer.create('#ar-web-designer', {
	documents: {
       handlers: {
			onBeforeOpen: () => {
				return new Promise((resolve, reject) => {
					resolve(false);
				});
			}
       }
	}
});

GrapeCity.ActiveReports.Designer.create('#ar-web-designer', {
	documents: {
       handlers: {
			onBeforeOpen: () => {
				return new Promise((resolve, reject) => {
					resolve(false);
				});
			}
       }
	}
});

---

onBeforeSave()?

optional onBeforeSave: (info) => Promise<boolean>;

An async handler, cancels saving process if returned false

Parameters

info

SaveDocumentInfo

Returns

Promise<boolean>

Examples

// ESM usage
import { arWebDesigner } from './web-designer.js';
arWebDesigner.create('#ar-web-designer', {
		documents: {
			fileView: {
		handlers: {
			onBeforeSave: (info) => {
				return new Promise((resolve, reject) => {
					resolve(false);
				});
			}
		}
});

// UMD usage
GrapeCity.ActiveReports.Designer.create('#ar-web-designer', {
	documents: {
		handlers: {
			onBeforeSave: (info) => {
				return new Promise((resolve, reject) => {
					resolve(false);
				});
			}
		}
	}
});

GrapeCity.ActiveReports.Designer.create('#ar-web-designer', {
	documents: {
		handlers: {
			onBeforeSave: (info: SaveDocumentInfo) => {
				return new Promise((resolve, reject) => {
					resolve(false);
				});
			}
		}
	}
});

---

onDocumentChanged()?

optional onDocumentChanged: (options) => void;

A handler that is triggered when report content is changed

Parameters

options

document

any

hasUnsavedChanges

boolean

Returns

void

Examples

// ESM usage
import { arWebDesigner } from './web-designer.js';
arWebDesigner.create('#ar-web-designer', {
	documents: {
      handlers: {
			onDocumentChanged: (options) => {
				if (options.hasUnsavedChanges) console.log('Currently edited report has unsaved changes.');
			}
		}
	}
});

// UMD usage
GrapeCity.ActiveReports.Designer.create('#ar-web-designer', {
	documents: {
      handlers: {
			onDocumentChanged: (options) => {
				if (options.hasUnsavedChanges) console.log('Currently edited report has unsaved changes.');
			}
		}
	}
});

GrapeCity.ActiveReports.Designer.create('#ar-web-designer', {
	documents: {
		handlers: {
			onDocumentChanged: (options: { document: any, hasUnsavedChanges: boolean }) => {
				if (options.hasUnsavedChanges) console.log('Currently edited report has unsaved changes.');
			}
		}
	}
});

---

onInfoUpdate()?

optional onInfoUpdate: (options) => void;

A handler that is triggered when report name/id is updated

Parameters

options

id?

string

name

string

platform

SupportedDocumentType["platform"]

type

SupportedDocumentType["type"]

Returns

void

Examples

// ESM usage
import { arWebDesigner } from './web-designer.js';
arWebDesigner.create('#ar-web-designer', {
	documents: {
      handlers: {
          onInfoUpdate: (options) => {
				console.log(`name changed ${options.name}`);
			}
		}
	}
});

// UMD usage
GrapeCity.ActiveReports.Designer.create('#ar-web-designer', {
	documents: {
      handlers: {
          onInfoUpdate: (options) => {
				console.log(`name changed ${options.name}`);
			}
		}
	}
});

GrapeCity.ActiveReports.Designer.create('#ar-web-designer', {
	documents: {
      handlers: {
          onInfoUpdate: (options:
               {
                   name: string,
                   id?: string,
                   type: SupportedDocumentType['type'],
                   platform: SupportedDocumentType['platform']
               }) =>
					{console.log(`name changed ${options.name}`);}
		}
	}
});