Word.RepeatingSectionContentControl class
Stellt das RepeatingSectionContentControl Objekt dar.
- Extends
Hinweise
Verwendet von
Eigenschaften
| allow |
Gibt an, ob Benutzer über die Benutzeroberfläche Abschnitte zu diesem Inhaltssteuerelement für wiederholte Abschnitte hinzufügen oder daraus entfernen können. |
| appearance | Gibt die Darstellung des Inhaltssteuerelements an. |
| color | Gibt den Rot-Grün-Blau-Wert (RGB) der Farbe des Inhaltssteuerelements an. Sie können den Wert im Format "#RRGGBB" angeben. |
| context | Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| id | Gibt die Kennung für das Inhaltssteuerelement zurück. |
| is |
Gibt an, ob das Inhaltssteuerelement aus dem aktiven Dokument entfernt werden soll, wenn der Benutzer den Inhalt des Steuerelements bearbeitet. |
| level | Gibt die Ebene des Inhaltssteuerelements zurück – ob das Inhaltssteuerelement Text, Absätze, Tabellenzellen oder Tabellenzeilen umschließt; oder ob sie inline ist. |
| lock |
Gibt an, ob das Inhaltssteuerelement gesperrt ist (kann nicht gelöscht werden).
|
| lock |
Gibt an, ob der Inhalt des Inhaltssteuerelements gesperrt (nicht bearbeitbar) ist.
|
| placeholder |
Gibt ein |
| range | Ruft ein |
| repeating |
Gibt die Auflistung der Elemente für wiederholte Abschnitte in diesem Inhaltssteuerelement für wiederholte Abschnitte zurück. |
| repeating |
Gibt den Namen der Elemente für den wiederholten Abschnitt an, die im Kontextmenü verwendet werden, das diesem Inhaltssteuerelement für wiederholten Abschnitt zugeordnet ist. |
| showing |
Gibt zurück, ob der Platzhaltertext für das Inhaltssteuerelement angezeigt wird. |
| tag | Gibt ein Tag zur Identifizierung des Inhaltssteuerelements an. |
| title | Gibt den Titel für das Inhaltssteuerelement an. |
| xml |
Gibt ein |
Methoden
| copy() | Kopiert das Inhaltssteuerelement aus dem aktiven Dokument in die Zwischenablage. |
| cut() | Entfernt das Inhaltssteuerelement aus dem aktiven Dokument und verschiebt dieses in die Zwischenablage. |
| delete(delete |
Löscht das Inhaltssteuerelement und den Inhalt des Inhaltssteuerelements. |
| 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 den Platzhaltertext fest, der im Inhaltssteuerelement angezeigt wird, bis ein Benutzer einen eigenen Text einfügt. |
| 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 aufrufübergreifend |
| 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 einen Aufruf durchführen |
Details zur Eigenschaft
allowInsertDeleteSection
Gibt an, ob Benutzer über die Benutzeroberfläche Abschnitte zu diesem Inhaltssteuerelement für wiederholte Abschnitte hinzufügen oder daraus entfernen können.
allowInsertDeleteSection: boolean;
Eigenschaftswert
boolean
Hinweise
appearance
Gibt die Darstellung des Inhaltssteuerelements an.
appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden";
Eigenschaftswert
Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"
Hinweise
color
Gibt den Rot-Grün-Blau-Wert (RGB) der Farbe des Inhaltssteuerelements an. Sie können den Wert im Format "#RRGGBB" angeben.
color: string;
Eigenschaftswert
string
Hinweise
context
Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
context: RequestContext;
Eigenschaftswert
id
Gibt die Kennung für das Inhaltssteuerelement zurück.
readonly id: string;
Eigenschaftswert
string
Hinweise
isTemporary
Gibt an, ob das Inhaltssteuerelement aus dem aktiven Dokument entfernt werden soll, wenn der Benutzer den Inhalt des Steuerelements bearbeitet.
isTemporary: boolean;
Eigenschaftswert
boolean
Hinweise
level
Gibt die Ebene des Inhaltssteuerelements zurück – ob das Inhaltssteuerelement Text, Absätze, Tabellenzellen oder Tabellenzeilen umschließt; oder ob sie inline ist.
readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell";
Eigenschaftswert
Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"
Hinweise
lockContentControl
Gibt an, ob das Inhaltssteuerelement gesperrt ist (kann nicht gelöscht werden).
true bedeutet, dass der Benutzer es nicht aus dem aktiven Dokument löschen kann, bedeutet, false dass es gelöscht werden kann.
lockContentControl: boolean;
Eigenschaftswert
boolean
Hinweise
lockContents
Gibt an, ob der Inhalt des Inhaltssteuerelements gesperrt (nicht bearbeitbar) ist.
true bedeutet, dass der Benutzer den Inhalt nicht bearbeiten kann, bedeutet, false dass der Inhalt bearbeitet werden kann.
lockContents: boolean;
Eigenschaftswert
boolean
Hinweise
placeholderText
Gibt ein BuildingBlock Objekt zurück, das den Platzhaltertext für das Inhaltssteuerelement darstellt.
readonly placeholderText: Word.BuildingBlock;
Eigenschaftswert
Hinweise
range
Ruft ein Range Objekt ab, das den Inhalt des Inhaltssteuerelements im aktiven Dokument darstellt.
readonly range: Word.Range;
Eigenschaftswert
Hinweise
repeatingSectionItems
Gibt die Auflistung der Elemente für wiederholte Abschnitte in diesem Inhaltssteuerelement für wiederholte Abschnitte zurück.
readonly repeatingSectionItems: Word.RepeatingSectionItemCollection;
Eigenschaftswert
Hinweise
repeatingSectionItemTitle
Gibt den Namen der Elemente für den wiederholten Abschnitt an, die im Kontextmenü verwendet werden, das diesem Inhaltssteuerelement für wiederholten Abschnitt zugeordnet ist.
repeatingSectionItemTitle: string;
Eigenschaftswert
string
Hinweise
showingPlaceholderText
Gibt zurück, ob der Platzhaltertext für das Inhaltssteuerelement angezeigt wird.
readonly showingPlaceholderText: boolean;
Eigenschaftswert
boolean
Hinweise
tag
Gibt ein Tag zur Identifizierung des Inhaltssteuerelements an.
tag: string;
Eigenschaftswert
string
Hinweise
title
Gibt den Titel für das Inhaltssteuerelement an.
title: string;
Eigenschaftswert
string
Hinweise
xmlMapping
Hinweis
Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.
Gibt ein XmlMapping Objekt zurück, das die Zuordnung des Inhaltssteuerelements zu XML-Daten im Datenspeicher des Dokuments darstellt.
readonly xmlMapping: Word.XmlMapping;
Eigenschaftswert
Hinweise
Details zur Methode
copy()
Kopiert das Inhaltssteuerelement aus dem aktiven Dokument in die Zwischenablage.
copy(): void;
Gibt zurück
void
Hinweise
cut()
Entfernt das Inhaltssteuerelement aus dem aktiven Dokument und verschiebt dieses in die Zwischenablage.
cut(): void;
Gibt zurück
void
Hinweise
delete(deleteContents)
Löscht das Inhaltssteuerelement und den Inhalt des Inhaltssteuerelements.
delete(deleteContents?: boolean): void;
Parameter
- deleteContents
-
boolean
Optional. Gibt an, ob der Inhalt innerhalb des Steuerelements gelöscht werden soll.
Gibt zurück
void
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.RepeatingSectionContentControlLoadOptions): Word.RepeatingSectionContentControl;
Parameter
Stellt Optionen für die zu ladenden Eigenschaften des Objekts bereit.
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.RepeatingSectionContentControl;
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.RepeatingSectionContentControl;
Parameter
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select ist eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Kommas 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.RepeatingSectionContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void;
Parameter
Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.
- options
- OfficeExtension.UpdateOptions
Bietet eine Option zum Unterdrücken von Fehlern, wenn das properties-Objekt 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.RepeatingSectionContentControl): void;
Parameter
- properties
- Word.RepeatingSectionContentControl
Gibt zurück
void
setPlaceholderText(options)
Legt den Platzhaltertext fest, der im Inhaltssteuerelement angezeigt wird, bis ein Benutzer einen eigenen Text einfügt.
setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): void;
Parameter
Optional. Die Optionen zum Konfigurieren des Platzhaltertexts des Inhaltssteuerelements.
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 sie übergeben wird.) Während das ursprüngliche Word.RepeatingSectionContentControl Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Word.Interfaces.RepeatingSectionContentControlData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.
toJSON(): Word.Interfaces.RepeatingSectionContentControlData;
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 aufrufübergreifend .sync 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 ein "InvalidObjectPath"-Fehler angezeigt wird, müssen Sie das Objekt der nachverfolgten Objektsammlung hinzufügen, wenn das Objekt zum ersten Mal erstellt wurde. Wenn dieses Objekt Teil einer Sammlung ist, sollten Sie auch die übergeordnete Sammlung nachverfolgen.
track(): Word.RepeatingSectionContentControl;
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 einen Aufruf durchführen context.sync() , bevor die Speicherfreigabe wirksam wird.
untrack(): Word.RepeatingSectionContentControl;