Weitere Funktionen

Neben den genannten Funktionen gibt es noch weitere kleine Helfer-Funktionen.

foreachRegister

Mit der foreachRegister Funktion kann man über die Register in einem DocFile iterieren.

Iterators.foreachRegister(
    docFile: DocFile,
    callback: (currentRegister: Register, index: number) => void,
    options: {
        type?: "documents" | "fields" | "links" | "archiveddocuments" | "externalcall" | "all";
        checkAccessRight?: boolean;
    } = { type: "all", checkAccessRight: true }
);

Beispiel:

context.enableModules();
const { Iterators } = require("ou.sp.Iterators");

Iterators.foreachRegister(context.file, (register, index) => {
    util.log(register.name);
});

foreachDocumentsInRegister

Mit der foreachDocumentsInRegister Funktion kann man über die Dokumente in einem Register iterieren.

Iterators.foreachDocumentsInRegister(register: Register, callback: (currentItem: Document, index: number) => void);

Beispiel:

context.enableModules();
const { Iterators } = require("ou.sp.Iterators");

const register = context.file.getRegisterByName("Documents");
Iterators.foreachDocumentsInRegister(register, (document, index) => {
    util.log(document.name);
})