Word.TableStyle class
Stellt das TableStyle -Objekt dar.
- Extends
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/40-tables/manage-custom-style.yaml
// Gets the table style properties and displays them in the form.
const styleName = (document.getElementById("style-name") as HTMLInputElement).value;
if (styleName == "") {
console.warn("Please input a table style name.");
return;
}
await Word.run(async (context) => {
const tableStyle: Word.TableStyle = context.document.getStyles().getByName(styleName).tableStyle;
tableStyle.load();
await context.sync();
if (tableStyle.isNullObject) {
console.warn(`There's no existing table style with the name '${styleName}'.`);
return;
}
console.log(tableStyle);
(document.getElementById("alignment") as HTMLInputElement).value = tableStyle.alignment;
(document.getElementById("allow-break-across-page") as HTMLInputElement).value = tableStyle.allowBreakAcrossPage.toString();
(document.getElementById("top-cell-margin") as HTMLInputElement).value = tableStyle.topCellMargin;
(document.getElementById("bottom-cell-margin") as HTMLInputElement).value = tableStyle.bottomCellMargin;
(document.getElementById("left-cell-margin") as HTMLInputElement).value = tableStyle.leftCellMargin;
(document.getElementById("right-cell-margin") as HTMLInputElement).value = tableStyle.rightCellMargin;
(document.getElementById("cell-spacing") as HTMLInputElement).value = tableStyle.cellSpacing;
});
Eigenschaften
| alignment | Gibt die Ausrichtung der Tabelle am Seitenrand an. |
| allow |
Gibt an, ob Zeilen in Tabellen, die mit einem Formatvorlagenwechsel über Seiten formatiert sind. |
| borders | Gibt einen |
| bottom |
Gibt den Platz an, der zwischen dem Inhalt und den unteren Rahmen der Zellen hinzugefügt werden soll. |
| cell |
Gibt den Abstand (in Punkt) zwischen den Zellen in einem Tabellenformat an. |
| column |
Gibt die Anzahl der Spalten in der Bänderung an, wenn eine Formatvorlage ungerade oder gerade Spaltenbänder angibt. |
| context | Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| is |
Gibt an, ob Microsoft Word ermöglicht, die angegebene Tabelle seitenübergreifend aufzubrechen. |
| left |
Gibt den Platz an, der zwischen dem Inhalt und den linken Rahmen der Zellen hinzugefügt werden soll. |
| left |
Gibt den linken Einzugswert (in Punkt) für die Zeilen im Tabellenformat an. |
| right |
Gibt den Abstand an, der zwischen dem Inhalt und den rechten Rahmen der Zellen hinzugefügt werden soll. |
| row |
Gibt die Anzahl der Zeilen an, die in das Banding eingeschlossen werden sollen, wenn die Formatvorlage ungerade oder gerade Zeilenbänder angibt. |
| shading | Gibt ein |
| table |
Gibt die Richtung an, in der Microsoft Word Zellen im Tabellenformat sortiert. |
| top |
Gibt den Platz an, der zwischen dem Inhalt und den oberen Rahmen der Zellen hinzugefügt werden soll. |
Methoden
| condition(condition |
Gibt ein |
| condition(condition |
Gibt 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(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
alignment
Gibt die Ausrichtung der Tabelle am Seitenrand an.
alignment: Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified";Eigenschaftswert
Word.Alignment | "Mixed" | "Unknown" | "Left" | "Centered" | "Right" | "Justified"
Hinweise
allowBreakAcrossPage
Gibt an, ob Zeilen in Tabellen, die mit einem Formatvorlagenwechsel über Seiten formatiert sind.
allowBreakAcrossPage: boolean;Eigenschaftswert
boolean
Hinweise
borders
Gibt einen BorderUniversalCollection zurück, der alle Rahmen für die Tabelle darstellt.
readonly borders: Word.BorderUniversalCollection;Eigenschaftswert
Hinweise
bottomCellMargin
Gibt den Platz an, der zwischen dem Inhalt und den unteren Rahmen der Zellen hinzugefügt werden soll.
bottomCellMargin: number;Eigenschaftswert
number
Hinweise
cellSpacing
Gibt den Abstand (in Punkt) zwischen den Zellen in einem Tabellenformat an.
cellSpacing: number;Eigenschaftswert
number
Hinweise
columnStripe
Gibt die Anzahl der Spalten in der Bänderung an, wenn eine Formatvorlage ungerade oder gerade Spaltenbänder angibt.
columnStripe: 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
isBreakAcrossPagesAllowed
Gibt an, ob Microsoft Word ermöglicht, die angegebene Tabelle seitenübergreifend aufzubrechen.
isBreakAcrossPagesAllowed: boolean;Eigenschaftswert
boolean
Hinweise
leftCellMargin
Gibt den Platz an, der zwischen dem Inhalt und den linken Rahmen der Zellen hinzugefügt werden soll.
leftCellMargin: number;Eigenschaftswert
number
Hinweise
leftIndent
Gibt den linken Einzugswert (in Punkt) für die Zeilen im Tabellenformat an.
leftIndent: number;Eigenschaftswert
number
Hinweise
rightCellMargin
Gibt den Abstand an, der zwischen dem Inhalt und den rechten Rahmen der Zellen hinzugefügt werden soll.
rightCellMargin: number;Eigenschaftswert
number
Hinweise
rowStripe
Gibt die Anzahl der Zeilen an, die in das Banding eingeschlossen werden sollen, wenn die Formatvorlage ungerade oder gerade Zeilenbänder angibt.
rowStripe: number;Eigenschaftswert
number
Hinweise
shading
Gibt ein ShadingUniversal -Objekt zurück, das auf die Schattierungsformatierung für die Tabellenformatvorlage verweist.
readonly shading: Word.Shading;Eigenschaftswert
Hinweise
tableDirection
Gibt die Richtung an, in der Microsoft Word Zellen im Tabellenformat sortiert.
tableDirection: Word.TableDirection | "RightToLeft" | "LeftToRight";Eigenschaftswert
Word.TableDirection | "RightToLeft" | "LeftToRight"
Hinweise
topCellMargin
Gibt den Platz an, der zwischen dem Inhalt und den oberen Rahmen der Zellen hinzugefügt werden soll.
topCellMargin: number;Eigenschaftswert
number
Hinweise
Details zur Methode
condition(conditionCode)
Gibt ein ConditionalStyle -Objekt zurück, das eine spezielle Formatierung für einen Teil einer Tabelle darstellt.
condition(conditionCode: Word.ConditionCode): Word.ConditionalStyle;Parameter
- conditionCode
- Word.ConditionCode
Der Bereich der Tabelle, auf den die Formatierung angewendet werden soll.
Gibt zurück
Hinweise
condition(conditionCode)
Gibt ein ConditionalStyle -Objekt zurück, das eine spezielle Formatierung für einen Teil einer Tabelle darstellt.
condition(conditionCode: "FirstRow" | "LastRow" | "OddRowBanding" | "EvenRowBanding" | "FirstColumn" | "LastColumn" | "OddColumnBanding" | "EvenColumnBanding" | "TopRightCell" | "TopLeftCell" | "BottomRightCell" | "BottomLeftCell"): Word.ConditionalStyle;Parameter
- conditionCode
-
"FirstRow" | "LastRow" | "OddRowBanding" | "EvenRowBanding" | "FirstColumn" | "LastColumn" | "OddColumnBanding" | "EvenColumnBanding" | "TopRightCell" | "TopLeftCell" | "BottomRightCell" | "BottomLeftCell"
Der Bereich der Tabelle, auf den die Formatierung angewendet werden soll.
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?: Word.Interfaces.TableStyleLoadOptions): Word.TableStyle;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[]): Word.TableStyle;Parameter
- propertyNames
-
string | string[]
Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.
Gibt zurück
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;
}): Word.TableStyle;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.TableStyleUpdateData, options?: OfficeExtension.UpdateOptions): void;Parameter
- properties
- Word.Interfaces.TableStyleUpdateData
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: Word.TableStyle): void;Parameter
- properties
- Word.TableStyle
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 Word.TableStyle Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Word.Interfaces.TableStyleData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.
toJSON(): Word.Interfaces.TableStyleData;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. Wenn dieses Objekt Teil einer Auflistung ist, sollten Sie auch die übergeordnete Auflistung nachverfolgen.
track(): Word.TableStyle;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(): Word.TableStyle;