OneNote.Table class
Stellt eine Tabelle auf einer OneNote-Seite dar.
- Extends
Hinweise
Eigenschaften
| border |
Ruft ab oder legt fest, ob die Rahmen angezeigt werden oder nicht. „True“, wenn sie sichtbar sind, „false“, wenn sie ausgeblendet sind. |
| column |
Ruft die Anzahl der Spalten in der Tabelle 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 Tabelle ab. Schreibgeschützt. |
| paragraph | Ruft das Paragraph-Objekt ab, das das Table-Objekt enthält. Schreibgeschützt. |
| row |
Ruft die Anzahl der Zeilen in der Tabelle ab. |
| rows | Ruft alle Zeilen der Tabelle ab. Schreibgeschützt. |
Methoden
| append |
Fügt am Ende der Tabelle eine Spalte hinzu. Werte werden, sofern angegeben, in der neuen Spalte festgelegt. Andernfalls ist die Spalte leer. |
| append |
Fügt am Ende der Tabelle eine Zeile hinzu. Werte, sofern angegeben, werden in der neuen Zeile festgelegt. Andernfalls ist die Zeile leer. |
| clear() | Löscht den Inhalt der Tabelle. |
| get |
Ruft die Tabellenzelle in einer angegebenen Zeile und Spalte ab. |
| insert |
Fügt eine Spalte am angegebenen Index in die Tabelle ein. Werte werden, sofern angegeben, in der neuen Spalte festgelegt. Andernfalls ist die Spalte leer. |
| insert |
Fügt eine Zeile am angegebenen Index in der Tabelle ein. Werte, sofern angegeben, werden in der neuen Zeile festgelegt. Andernfalls ist die Zeile leer. |
| 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. |
| set |
Legt die Farbe aller Zellen in der Tabelle fest. Der Farbcode, auf den die Zellen festgelegt werden sollen. |
| toJSON() | Überschreibt die JavaScript-Methode |
| track() | Nachverfolgung des Objekts zwecks automatischer Anpassung auf der Grundlage der umgebenden Änderungen im Dokument. Dieser Aufruf ist eine Abkürzung für |
| untrack() | Gibt den diesem Objekt zugewiesenen Arbeitsspeicher frei, wenn das Objekt zuvor nachverfolgt wurde. Dieser Aufruf ist die Kurzform für |
Details zur Eigenschaft
borderVisible
Ruft ab oder legt fest, ob die Rahmen angezeigt werden oder nicht. „True“, wenn sie sichtbar sind, „false“, wenn sie ausgeblendet sind.
borderVisible: boolean;Eigenschaftswert
boolean
Hinweise
columnCount
Ruft die Anzahl der Spalten in der Tabelle ab.
readonly columnCount: 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 Tabelle ab. Schreibgeschützt.
readonly id: string;Eigenschaftswert
string
Hinweise
paragraph
Ruft das Paragraph-Objekt ab, das das Table-Objekt enthält. Schreibgeschützt.
readonly paragraph: OneNote.Paragraph;Eigenschaftswert
Hinweise
rowCount
Ruft die Anzahl der Zeilen in der Tabelle ab.
readonly rowCount: number;Eigenschaftswert
number
Hinweise
rows
Ruft alle Zeilen der Tabelle ab. Schreibgeschützt.
readonly rows: OneNote.TableRowCollection;Eigenschaftswert
Hinweise
Details zur Methode
appendColumn(values)
Fügt am Ende der Tabelle eine Spalte hinzu. Werte werden, sofern angegeben, in der neuen Spalte festgelegt. Andernfalls ist die Spalte leer.
appendColumn(values?: string[]): void;Parameter
- values
-
string[]
Optional. Zeichenfolgen, die in der neuen Spalte einzufügen sind, angegeben als Array. Darf nicht mehr Werte als Zeilen in der Tabelle enthalten.
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, append a column.
for (let i = 0; i < paragraphs.items.length; i++) {
const paragraph = paragraphs.items[i];
if (paragraph.type == "Table") {
const table = paragraph.table;
table.appendColumn(["cell0", "cell1"]);
}
}
await context.sync();
});
appendRow(values)
Fügt am Ende der Tabelle eine Zeile hinzu. Werte, sofern angegeben, werden in der neuen Zeile festgelegt. Andernfalls ist die Zeile leer.
appendRow(values?: string[]): OneNote.TableRow;Parameter
- values
-
string[]
Optional. Zeichenfolgen, die in der neuen Zeile einzufügen sind, angegeben als Array. Darf nicht mehr Werte als Spalten in der Tabelle enthalten.
Gibt zurück
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, append a column.
for (let i = 0; i < paragraphs.items.length; i++) {
const paragraph = paragraphs.items[i];
if (paragraph.type == "Table") {
const table = paragraph.table;
const row = table.appendRow(["cell0", "cell1"]);
}
}
await context.sync();
});
clear()
Löscht den Inhalt der Tabelle.
clear(): void;Gibt zurück
void
Hinweise
getCell(rowIndex, cellIndex)
Ruft die Tabellenzelle in einer angegebenen Zeile und Spalte ab.
getCell(rowIndex: number, cellIndex: number): OneNote.TableCell;Parameter
- rowIndex
-
number
Der Index der Zeile.
- cellIndex
-
number
Der Index der Zelle in der Zeile.
Gibt zurück
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 cell in the second row and third column.
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(2 /*Row Index*/, 3 /*Column Index*/);
}
}
await context.sync();
});
insertColumn(index, values)
Fügt eine Spalte am angegebenen Index in die Tabelle ein. Werte werden, sofern angegeben, in der neuen Spalte festgelegt. Andernfalls ist die Spalte leer.
insertColumn(index: number, values?: string[]): void;Parameter
- index
-
number
Index, an dem die Spalte in die Tabelle eingefügt wird.
- values
-
string[]
Optional. Zeichenfolgen, die in der neuen Spalte einzufügen sind, angegeben als Array. Darf nicht mehr Werte als Zeilen in der Tabelle enthalten.
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, insert a column at index two.
for (let i = 0; i < paragraphs.items.length; i++) {
const paragraph = paragraphs.items[i];
if (paragraph.type == "Table") {
const table = paragraph.table;
table.insertColumn(2, ["cell0", "cell1"]);
}
}
await context.sync();
});
insertRow(index, values)
Fügt eine Zeile am angegebenen Index in der Tabelle ein. Werte, sofern angegeben, werden in der neuen Zeile festgelegt. Andernfalls ist die Zeile leer.
insertRow(index: number, values?: string[]): OneNote.TableRow;Parameter
- index
-
number
Index, an dem die Zeile in die Tabelle eingefügt wird.
- values
-
string[]
Optional. Zeichenfolgen, die in der neuen Zeile einzufügen sind, angegeben als Array. Darf nicht mehr Werte als Spalten in der Tabelle enthalten.
Gibt zurück
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, insert a row at index two.
for (let i = 0; i < paragraphs.items.length; i++) {
const paragraph = paragraphs.items[i];
if (paragraph.type == "Table") {
const table = paragraph.table;
const row = table.insertRow(2, ["cell0", "cell1"]);
}
}
await context.sync();
});
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.TableLoadOptions): OneNote.Table;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.Table;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/type");
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
const paragraphs = outline.paragraphs;
// For each table, log properties.
for (let i = 0; i < paragraphs.items.length; i++) {
const paragraph = paragraphs.items[i];
if (paragraph.type == "Table") {
const table = paragraph.table;
context.load(table);
await context.sync();
console.log("Table Id: " + table.id);
console.log("Row Count: " + table.rowCount);
console.log("Column Count: " + table.columnCount);
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.Table;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.TableUpdateData, options?: OfficeExtension.UpdateOptions): void;Parameter
- properties
- OneNote.Interfaces.TableUpdateData
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.Table): void;Parameter
- properties
- OneNote.Table
Gibt zurück
void
setShadingColor(colorCode)
Legt die Farbe aller Zellen in der Tabelle fest. Der Farbcode, auf den die Zellen festgelegt werden sollen.
setShadingColor(colorCode: string): void;Parameter
- colorCode
-
string
Gibt zurück
void
Hinweise
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.Table-Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als OneNote.Interfaces.TableData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.
toJSON(): OneNote.Interfaces.TableData;Gibt zurück
track()
Nachverfolgung des Objekts zwecks automatischer Anpassung auf der Grundlage der umgebenden Änderungen im Dokument. Dieser Aufruf ist eine Abkürzung für context.trackedObjects.add(thisObject). Wenn Sie dieses Objekt über .sync Aufrufe 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, mussten Sie das Objekt der nachverfolgten Objektauflistung hinzugefügt haben, als das Objekt zum ersten Mal erstellt wurde.
track(): OneNote.Table;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.Table;Gibt zurück
Office Add-ins
Feedback
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unter https://aka.ms/ContentUserFeedback.
Feedback senden und anzeigen für