Word.Interfaces.ContentControlData interface

  • Referenz
Paket:
word

Eine Schnittstelle, die die durch Aufrufen contentControl.toJSON()von zurückgegebenen Daten beschreibt.

Eigenschaften

appearance

Gibt die Darstellung des Inhaltssteuerelements an. Der Wert kann "BoundingBox", "Tags" oder "Hidden" sein.
cannotDelete

Gibt einen Wert an, der angibt, ob der Benutzer das Inhaltssteuerelement löschen kann. Sich gegenseitig ausschließend mit removeWhenEdited.
cannotEdit

Gibt einen Wert an, der angibt, ob der Benutzer den Inhalt des Inhaltssteuerelements bearbeiten kann.
color

Gibt die Farbe des Inhaltssteuerelements an. Die Farbe wird im Format "#RRGGBB" oder unter Verwendung des Farbnamens angegeben.
contentControls

Ruft die Auflistung von Inhaltssteuerelement-Objekten im Inhaltssteuerelement ab.
font

Ruft das Textformat des Inhaltssteuerelements ab. Verwenden Sie diese zum Abrufen und Festlegen der Schriftart, Größe, Farbe und andere Eigenschaften.
id

Ruft eine Ganzzahl ab, die den Inhaltssteuerelement-Bezeichner darstellt.
inlinePictures

Ruft die Auflistung von InlinePicture-Objekten im Inhaltssteuerelement ab. Die Auflistung enthält keine unverankerten Bilder.
paragraphs

Ruft die Auflistung von Absatzobjekten im Inhaltssteuerelement ab.
placeholderText

Gibt den Platzhaltertext des Inhaltssteuerelements an. Abgeblendeter Text wird angezeigt, wenn das Inhaltssteuerelement leer ist.
removeWhenEdited

Gibt einen Wert an, der angibt, ob das Inhaltssteuerelement entfernt wird, nachdem es bearbeitet wurde. Sich gegenseitig ausschließend mit CannotDelete.
style

Gibt den Formatvorlagennamen für das Inhaltssteuerelement an. Verwenden Sie diese Eigenschaft für benutzerdefinierte Formatvorlagen und lokalisierte Formatvorlagennamen. Informationen zur Verwendung der integrierten Formatvorlagen, die zwischen Gebietsschemas portabel sind, finden Sie unter der Eigenschaft "styleBuiltIn".
tag

Gibt ein Tag zum Identifizieren eines Inhaltssteuerelements an.
text

Ruft den Text des Inhaltssteuerelements ab.
title

Gibt den Titel für ein Inhaltssteuerelement an.
type

Ruft den Typen des Inhaltssteuerelements ab. Derzeit werden nur Rich-Text-, Nur-Text- und Kontrollkästchen-Inhaltssteuerelemente unterstützt.

Details zur Eigenschaft

appearance

Gibt die Darstellung des Inhaltssteuerelements an. Der Wert kann "BoundingBox", "Tags" oder "Hidden" sein.

appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden";

Eigenschaftswert

Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"

Hinweise

[ API-Satz: WordApi 1.1 ]

cannotDelete

Gibt einen Wert an, der angibt, ob der Benutzer das Inhaltssteuerelement löschen kann. Sich gegenseitig ausschließend mit removeWhenEdited.

cannotDelete?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApi 1.1 ]

cannotEdit

Gibt einen Wert an, der angibt, ob der Benutzer den Inhalt des Inhaltssteuerelements bearbeiten kann.

cannotEdit?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApi 1.1 ]

color

Gibt die Farbe des Inhaltssteuerelements an. Die Farbe wird im Format "#RRGGBB" oder unter Verwendung des Farbnamens angegeben.

color?: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: WordApi 1.1 ]

contentControls

Ruft die Auflistung von Inhaltssteuerelement-Objekten im Inhaltssteuerelement ab.

contentControls?: Word.Interfaces.ContentControlData[];

Eigenschaftswert

Word.Interfaces.ContentControlData[]

Hinweise

[ API-Satz: WordApi 1.1 ]

font

Ruft das Textformat des Inhaltssteuerelements ab. Verwenden Sie diese zum Abrufen und Festlegen der Schriftart, Größe, Farbe und andere Eigenschaften.

font?: Word.Interfaces.FontData;

Eigenschaftswert

Word.Interfaces.FontData

Hinweise

[ API-Satz: WordApi 1.1 ]

id

Ruft eine Ganzzahl ab, die den Inhaltssteuerelement-Bezeichner darstellt.

id?: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: WordApi 1.1 ]

inlinePictures

Ruft die Auflistung von InlinePicture-Objekten im Inhaltssteuerelement ab. Die Auflistung enthält keine unverankerten Bilder.

inlinePictures?: Word.Interfaces.InlinePictureData[];

Eigenschaftswert

Word.Interfaces.InlinePictureData[]

Hinweise

[ API-Satz: WordApi 1.1 ]

paragraphs

Ruft die Auflistung von Absatzobjekten im Inhaltssteuerelement ab.

paragraphs?: Word.Interfaces.ParagraphData[];

Eigenschaftswert

Word.Interfaces.ParagraphData[]

Hinweise

[ API-Satz: WordApi 1.1 ]

Wichtig: Für die Anforderungssätze 1.1 und 1.2 werden Absätze in Tabellen, die vollständig in diesem Inhaltssteuerelement enthalten sind, nicht zurückgegeben. Ab Anforderungssatz 1.3 werden auch Absätze in solchen Tabellen zurückgegeben.

placeholderText

Gibt den Platzhaltertext des Inhaltssteuerelements an. Abgeblendeter Text wird angezeigt, wenn das Inhaltssteuerelement leer ist.

placeholderText?: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: WordApi 1.1 ]

removeWhenEdited

Gibt einen Wert an, der angibt, ob das Inhaltssteuerelement entfernt wird, nachdem es bearbeitet wurde. Sich gegenseitig ausschließend mit CannotDelete.

removeWhenEdited?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApi 1.1 ]

style

Gibt den Formatvorlagennamen für das Inhaltssteuerelement an. Verwenden Sie diese Eigenschaft für benutzerdefinierte Formatvorlagen und lokalisierte Formatvorlagennamen. Informationen zur Verwendung der integrierten Formatvorlagen, die zwischen Gebietsschemas portabel sind, finden Sie unter der Eigenschaft "styleBuiltIn".

style?: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: WordApi 1.1 ]

tag

Gibt ein Tag zum Identifizieren eines Inhaltssteuerelements an.

tag?: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: WordApi 1.1 ]

text

Ruft den Text des Inhaltssteuerelements ab.

text?: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: WordApi 1.1 ]

title

Gibt den Titel für ein Inhaltssteuerelement an.

title?: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: WordApi 1.1 ]

type

Ruft den Typen des Inhaltssteuerelements ab. Derzeit werden nur Rich-Text-, Nur-Text- und Kontrollkästchen-Inhaltssteuerelemente unterstützt.

type?: Word.ContentControlType | "Unknown" | "RichTextInline" | "RichTextParagraphs" | "RichTextTableCell" | "RichTextTableRow" | "RichTextTable" | "PlainTextInline" | "PlainTextParagraph" | "Picture" | "BuildingBlockGallery" | "CheckBox" | "ComboBox" | "DropDownList" | "DatePicker" | "RepeatingSection" | "RichText" | "PlainText";

Eigenschaftswert

Word.ContentControlType | "Unknown" | "RichTextInline" | "RichTextParagraphs" | "RichTextTableCell" | "RichTextTableRow" | "RichTextTable" | "PlainTextInline" | "PlainTextParagraph" | "Picture" | "BuildingBlockGallery" | "CheckBox" | "ComboBox" | "DropDownList" | "DatePicker" | "RepeatingSection" | "RichText" | "PlainText"

Hinweise

[ API-Satz: WordApi 1.1 ]