OneNote.TableRow class
Stellt eine Zeile in einer Tabelle dar.
- Extends
Hinweise
Eigenschaften
| cell |
Ruft die Anzahl der Zellen in der Zeile ab. |
| cells | Ruft die Zellen 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 Zeile ab. |
| parent |
Ruft die übergeordnete Tabelle ab. |
| row |
Ruft den Index der Zeile in der übergeordneten Tabelle ab. |
Methoden
| clear() | Löscht den Inhalt der Zeile. |
| insert |
Fügt eine Zeile vor oder nach der aktuellen Zeile ein. |
| insert |
Fügt eine Zeile vor oder nach der aktuellen Zeile ein. |
| 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 |
Legt die Farbe aller Zellen in der Zeile 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 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
cellCount
Ruft die Anzahl der Zellen in der Zeile ab.
readonly cellCount: number;Eigenschaftswert
number
Hinweise
cells
Ruft die Zellen in der Zeile ab.
readonly cells: OneNote.TableCellCollection;Eigenschaftswert
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 Zeile ab.
readonly id: string;Eigenschaftswert
string
Hinweise
parentTable
Ruft die übergeordnete Tabelle ab.
readonly parentTable: OneNote.Table;Eigenschaftswert
Hinweise
rowIndex
Ruft den Index der Zeile in der übergeordneten Tabelle ab.
readonly rowIndex: number;Eigenschaftswert
number
Hinweise
Details zur Methode
clear()
insertRowAsSibling(insertLocation, values)
Fügt eine Zeile vor oder nach der aktuellen Zeile ein.
insertRowAsSibling(insertLocation: OneNote.InsertLocation, values?: string[]): OneNote.TableRow;Parameter
- insertLocation
- OneNote.InsertLocation
Position, an der die neuen Zeilen eingefügt werden sollen, relativ zur aktuellen Zeile.
- values
-
string[]
Zeichenfolgen, die in der neuen Zeile einzufügen sind, angegeben als Array. Darf nicht mehr Zellen als die aktuelle Zeile enthalten. Optional.
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 table rows.
for (let i = 0; i < paragraphs.items.length; i++) {
const paragraph = paragraphs.items[i];
if (paragraph.type == "Table") {
const table = paragraph.table;
// Queue a command to load table.rows.
context.load(table, "rows");
// Run the queued commands.
await context.sync();
const rows = table.rows;
rows.items[1].insertRowAsSibling("Before", ["cell0", "cell1"]);
await context.sync();
}
}
});
insertRowAsSibling(insertLocationString, values)
Fügt eine Zeile vor oder nach der aktuellen Zeile ein.
insertRowAsSibling(insertLocationString: "Before" | "After", values?: string[]): OneNote.TableRow;Parameter
- insertLocationString
-
"Before" | "After"
Position, an der die neuen Zeilen eingefügt werden sollen, relativ zur aktuellen Zeile.
- values
-
string[]
Zeichenfolgen, die in der neuen Zeile einzufügen sind, angegeben als Array. Darf nicht mehr Zellen als die aktuelle Zeile enthalten. Optional.
Gibt zurück
Hinweise
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.TableRowLoadOptions): OneNote.TableRow;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.TableRow;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 table rows.
for (let i = 0; i < paragraphs.items.length; i++) {
const paragraph = paragraphs.items[i];
if (paragraph.type == "Table") {
const table = paragraph.table;
// Queue a command to load table.rows.
context.load(table, "rows");
await context.sync();
const rows = table.rows;
// For each table row, log cell count and row index.
for (let i = 0; i < rows.items.length; i++) {
console.log("Row " + i + " Id: " + rows.items[i].id);
console.log("Row " + i + " Cell Count: " + rows.items[i].cellCount);
console.log("Row " + i + " Row Index: " + rows.items[i].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.TableRow;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
setShadingColor(colorCode)
Legt die Farbe aller Zellen in der Zeile 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.TableRow Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als OneNote.Interfaces.TableRowData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.
toJSON(): OneNote.Interfaces.TableRowData;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.TableRow;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.TableRow;Gibt zurück
Office Add-ins