OneNote.TableCell class
Stellt eine Zelle in einer OneNote-Tabelle dar.
- Extends
Hinweise
Eigenschaften
| cell |
Ruft den Index der Zelle in der Zeile ab. |
| context | Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| id | Ruft die ID der Zelle ab. |
| paragraphs | Ruft die Auflistung von Paragraph-Objekten in der TableCell ab. |
| parent |
Ruft die übergeordnete Zeile der Zelle ab. |
| row |
Ruft den Index der Zeile mit der Zelle in der Tabelle ab. |
| shading |
Ruft die Schattierungsfarbe der Zelle ab und legt diese fest. |
Methoden
| append |
Fügt den angegebenen HTML-Code am Ende der TableCell hinzu. |
| append |
Fügt das angegebene Bild der Tabellenzelle hinzu. |
| append |
Fügt den angegebenen Text der Tabellenzelle hinzu. |
| append |
Fügt eine Tabelle mit der angegebenen Anzahl von Zeilen und Spalten zur Tabellenzelle hinzu. |
| clear() | Löscht den Inhalt der Zelle. |
| load(options) | Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| set(properties, options) | 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) | Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt. |
| toJSON() | Überschreibt die JavaScript-Methode |
| track() | 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 |
| untrack() | 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 |
Details zur Eigenschaft
cellIndex
Ruft den Index der Zelle in der Zeile ab.
readonly cellIndex: number;Eigenschaftswert
number
Hinweise
context
Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
context: RequestContext;Eigenschaftswert
id
Ruft die ID der Zelle ab.
readonly id: string;Eigenschaftswert
string
Hinweise
paragraphs
Ruft die Auflistung von Paragraph-Objekten in der TableCell ab.
readonly paragraphs: OneNote.ParagraphCollection;Eigenschaftswert
Hinweise
parentRow
Ruft die übergeordnete Zeile der Zelle ab.
readonly parentRow: OneNote.TableRow;Eigenschaftswert
Hinweise
rowIndex
Ruft den Index der Zeile mit der Zelle in der Tabelle ab.
readonly rowIndex: number;Eigenschaftswert
number
Hinweise
shadingColor
Ruft die Schattierungsfarbe der Zelle ab und legt diese fest.
shadingColor: string;Eigenschaftswert
string
Hinweise
Details zur Methode
appendHtml(html)
Fügt den angegebenen HTML-Code am Ende der TableCell hinzu.
appendHtml(html: string): void;Parameter
- html
-
string
Die HTML-Zeichenfolge, die angefügt werden soll. Weitere Informationen finden Sie unter Unterstütztes HTML für die JavaScript-API für OneNote-Add-Ins.
Gibt zurück
void
Hinweise
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();
});
appendImage(base64EncodedImage, width, height)
Fügt das angegebene Bild der Tabellenzelle hinzu.
appendImage(base64EncodedImage: string, width: number, height: number): OneNote.Image;Parameter
- base64EncodedImage
-
string
HTML-Zeichenfolge, die angefügt werden soll.
- width
-
number
Optional. Breite in der Maßeinheit Punkt. Der Standardwert ist null, und die Bildbreite wird beachtet.
- height
-
number
Optional. Höhe in der Maßeinheit Punkt. Der Standardwert ist null, und die Bildhöhe wird beachtet.
Gibt zurück
Hinweise
appendRichText(paragraphText)
Fügt den angegebenen Text der Tabellenzelle hinzu.
appendRichText(paragraphText: string): OneNote.RichText;Parameter
- paragraphText
-
string
HTML-Zeichenfolge, die angefügt werden soll.
Gibt zurück
Hinweise
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();
});
appendTable(rowCount, columnCount, values)
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
- rowCount
-
number
Erforderlich. Die Anzahl der Zeilen in der Tabelle.
- columnCount
-
number
Erforderlich. Die Anzahl der Spalten in der Tabelle.
- values
-
string[][]
Optionales 2D-Array. Wenn die entsprechenden Zeichenfolgen im Array angegeben sind, werden die Zellen gefüllt.
Gibt zurück
Hinweise
clear()
load(options)
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
Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.
Gibt zurück
load(propertyNames)
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
- propertyNames
-
string | string[]
Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.
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();
});
load(propertyNamesAndPaths)
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
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select ist eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.
Gibt zurück
set(properties, options)
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
- properties
- OneNote.Interfaces.TableCellUpdateData
Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.
- options
- OfficeExtension.UpdateOptions
Stellt eine Option zum Unterdrücken von Fehlern bereit, wenn das Eigenschaftenobjekt versucht, schreibgeschützte Eigenschaften festzulegen.
Gibt zurück
void
set(properties)
Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.
set(properties: OneNote.TableCell): void;Parameter
- properties
- OneNote.TableCell
Gibt zurück
void
toJSON()
Ü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
track()
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
untrack()
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
Office Add-ins