OneNote.TableCell class

Ruft den Index der Zelle in der Zeile ab.

readonly cellIndex: number;

Eigenschaftswert

Hinweise

[ API-Satz: OneNoteApi 1.1 ]

Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

context: RequestContext;

Eigenschaftswert

Ruft die ID der Zelle ab.

readonly id: string;

Eigenschaftswert

Hinweise

[ API-Satz: OneNoteApi 1.1 ]

Ruft die Auflistung von Paragraph-Objekten in der TableCell ab.

readonly paragraphs: OneNote.ParagraphCollection;

Eigenschaftswert

Hinweise

[ API-Satz: OneNoteApi 1.1 ]

Ruft die übergeordnete Zeile der Zelle ab.

readonly parentRow: OneNote.TableRow;

Eigenschaftswert

Hinweise

[ API-Satz: OneNoteApi 1.1 ]

Ruft den Index der Zeile mit der Zelle in der Tabelle ab.

readonly rowIndex: number;

Eigenschaftswert

Hinweise

[ API-Satz: OneNoteApi 1.1 ]

Ruft die Schattierungsfarbe der Zelle ab und legt diese fest.

shadingColor: string;

Eigenschaftswert

Hinweise

[ API-Satz: OneNoteApi 1.1 ]

Fügt den angegebenen HTML-Code am Ende der TableCell hinzu.

appendHtml(html: string): void;

Parameter

Gibt zurück

Hinweise

[ API-Satz: OneNoteApi 1.1 ]

Beispiele

await OneNote.run(async (context) => {
    const app = context.application;
    const outline = app.getActiveOutline();
    
    // Queue a command to load outline.paragraphs and their types.
    context.load(outline, "paragraphs, paragraphs/type");
    
    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();
    
    const paragraphs = outline.paragraphs;
    
    // For each table, get a table cell at row one and column two and add "Hello".
    for (let i = 0; i < paragraphs.items.length; i++) {
        const paragraph = paragraphs.items[i];
        if (paragraph.type == "Table") {
            const table = paragraph.table;
            const cell = table.getCell(1 /*Row Index*/, 2 /*Column Index*/);
            cell.appendHtml("<p>Hello</p>");
        }
    }
    await context.sync();
});

Fügt das angegebene Bild der Tabellenzelle hinzu.

appendImage(base64EncodedImage: string, width: number, height: number): OneNote.Image;

Parameter

Gibt zurück

Hinweise

[ API-Satz: OneNoteApi 1.1 ]

Fügt den angegebenen Text der Tabellenzelle hinzu.

appendRichText(paragraphText: string): OneNote.RichText;

Parameter

Gibt zurück

Hinweise

[ API-Satz: OneNoteApi 1.1 ]

Beispiele

await OneNote.run(async (context) => {
    const app = context.application;
    const outline = app.getActiveOutline();
    const appendedRichText = null;
    
    // Queue a command to load outline.paragraphs and their types.
    context.load(outline, "paragraphs, paragraphs/type");
    
    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();

    const paragraphs = outline.paragraphs;
    
    // For each table, get a table cell at row one and column two and add "Hello".
    for (let i = 0; i < paragraphs.items.length; i++) {
        const paragraph = paragraphs.items[i];
        if (paragraph.type == "Table") {
            const table = paragraph.table;
            const cell = table.getCell(1 /*Row Index*/, 2 /*Column Index*/);
            appendedRichText = cell.appendRichText("Hello");
        }
    }
    await context.sync();
});

Fügt eine Tabelle mit der angegebenen Anzahl von Zeilen und Spalten zur Tabellenzelle hinzu.

appendTable(rowCount: number, columnCount: number, values?: string[][]): OneNote.Table;

Parameter

Gibt zurück

Hinweise

[ API-Satz: OneNoteApi 1.1 ]

Löscht den Inhalt der Zelle.

clear(): void;

Gibt zurück

Hinweise

[ API-Satz: OneNoteApi 1.1 ]

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(options?: OneNote.Interfaces.TableCellLoadOptions): OneNote.TableCell;

Parameter

Gibt zurück

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNames?: string | string[]): OneNote.TableCell;

Parameter

Gibt zurück

Beispiele

await OneNote.run(async (context) => {
    const app = context.application;
    const outline = app.getActiveOutline();
    
    // Queue a command to load outline.paragraphs and their types.
    context.load(outline, "paragraphs, paragraphs/type");
    
    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();
    const paragraphs = outline.paragraphs;
    
    // For each table, get a table cell at row one and column two.
    for (let i = 0; i < paragraphs.items.length; i++) {
        const paragraph = paragraphs.items[i];
        if (paragraph.type == "Table") {
            const table = paragraph.table;
            const cell = table.getCell(1 /*Row Index*/, 2 /*Column Index*/);
            
            // Queue a command to load the table cell.
            context.load(cell);
            await context.sync();

            console.log("Cell Id: " + cell.id);
            console.log("Cell Index: " + cell.cellIndex);
            console.log("Cell's Row Index: " + cell.rowIndex);
        }
    }
    await context.sync();
});

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): OneNote.TableCell;

Parameter

Gibt zurück

Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.

set(properties: Interfaces.TableCellUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameter

Gibt zurück

Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.

set(properties: OneNote.TableCell): void;

Parameter

Gibt zurück

Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche OneNote.TableCell Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als OneNote.Interfaces.TableCellData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

toJSON(): OneNote.Interfaces.TableCellData;

Gibt zurück

Nachverfolgung des Objekts zwecks automatischer Anpassung auf der Grundlage der umgebenden Änderungen im Dokument. Dieser Aufruf ist eine Kurzform für context.trackedObjects.add(thisObject). Wenn Sie dieses Objekt über .sync Aufrufe hinweg und außerhalb der sequenziellen Ausführung eines ".run"-Batches verwenden und beim Festlegen einer Eigenschaft oder beim Aufrufen einer Methode für das Objekt den Fehler "InvalidObjectPath" erhalten, müssen Sie das Objekt der nachverfolgten Objektauflistung hinzufügen, als das Objekt zum ersten Mal erstellt wurde.

track(): OneNote.TableCell;

Gibt zurück

Gibt den diesem Objekt zugewiesenen Arbeitsspeicher frei, wenn das Objekt zuvor nachverfolgt wurde. Dieser Aufruf ist die Kurzform für context.trackedObjects.remove(thisObject). Viele nachverfolgte Objekte verlangsamen die Ausführung der Hostanwendung, also achten Sie darauf, alle hinzugefügten Objekte nach abgeschlossener Verwendung freizugeben. Sie müssen aufrufen context.sync() , bevor die Speicherfreigabe wirksam wird.

untrack(): OneNote.TableCell;

Gibt zurück