Freigeben über


Word.Interfaces.ContentControlLoadOptions interface

Stellt ein Inhaltssteuerelement dar. Inhaltssteuerelemente sind gebunden und potenziell beschrifteten Bereiche in einem Dokument, das als Container für bestimmte Arten von Inhalten dienen. Einzelne Inhaltssteuerelemente können Inhalte wie Bilder, Tabellen oder Absätze mit formatiertem Text enthalten. Derzeit werden nur Rich-Text-, Nur-Text- und Kontrollkästchen-Inhaltssteuerelemente unterstützt.

Hinweise

[ API-Satz: WordApi 1.1 ]

Eigenschaften

$all

Wenn Sie $all für die Ladeoptionen angeben, werden alle skalaren Eigenschaften (zRange.address. B. ) geladen, aber nicht die Navigationseigenschaften (zRange.format.fill.color. B. ).

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.

checkboxContentControl

Gibt die kontrollkästchenbezogenen Daten an, wenn der Typ des Inhaltssteuerelements "CheckBox" lautet. Andernfalls null ist es so.

color

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

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.

parentBody

Ruft den übergeordneten Text des Inhaltssteuerelements ab.

parentContentControl

Ruft das Inhaltssteuerelement ab, das das Inhaltssteuerelement enthält. Löst einen Fehler aus ItemNotFound , wenn kein übergeordnetes Inhaltssteuerelement vorhanden ist.

parentContentControlOrNullObject

Ruft das Inhaltssteuerelement ab, das das Inhaltssteuerelement enthält. Wenn kein übergeordnetes Inhaltssteuerelement vorhanden ist, gibt diese Methode ein Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

parentTable

Ruft die Tabelle ab, die das Inhaltssteuerelement enthält. Löst einen Fehler aus ItemNotFound , wenn er nicht in einer Tabelle enthalten ist.

parentTableCell

Ruft die Tabellenzelle ab, die das Inhaltssteuerelement enthält. Löst einen Fehler aus ItemNotFound , wenn er nicht in einer Tabellenzelle enthalten ist.

parentTableCellOrNullObject

Ruft die Tabellenzelle ab, die das Inhaltssteuerelement enthält. Wenn sie nicht in einer Tabellenzelle enthalten ist, gibt diese Methode ein Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

parentTableOrNullObject

Ruft die Tabelle ab, die das Inhaltssteuerelement enthält. Wenn sie nicht in einer Tabelle enthalten ist, gibt diese Methode ein -Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

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".

styleBuiltIn

Gibt den integrierten Formatvorlagennamen für das Inhaltssteuerelement an. Verwenden Sie diese Eigenschaft für integrierte Formatvorlagen, die zwischen Gebietsschemas portabel sind. Informationen zum Verwenden benutzerdefinierter Formatvorlagen oder lokalisierter Namen finden Sie unter der Eigenschaft "style".

subtype

Ruft den Untertyp des Inhaltssteuerelements ab. Der Untertyp kann "RichTextInline", "RichTextParagraphs", "RichTextTableCell", "RichTextTableRow" und "RichTextTable" für Rich-Text-Inhaltssteuerelemente oder "PlainTextInline" und "PlainTextParagraph" für Nur-Text-Inhaltssteuerelemente oder "CheckBox" für Kontrollkästcheninhaltssteuerelemente sein.

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

$all

Wenn Sie $all für die Ladeoptionen angeben, werden alle skalaren Eigenschaften (zRange.address. B. ) geladen, aber nicht die Navigationseigenschaften (zRange.format.fill.color. B. ).

$all?: boolean;

Eigenschaftswert

boolean

appearance

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

appearance?: boolean;

Eigenschaftswert

boolean

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 ]

checkboxContentControl

Gibt die kontrollkästchenbezogenen Daten an, wenn der Typ des Inhaltssteuerelements "CheckBox" lautet. Andernfalls null ist es so.

checkboxContentControl?: Word.Interfaces.CheckboxContentControlLoadOptions;

Eigenschaftswert

Hinweise

[ API-Satz: WordApi 1.7 ]

color

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

color?: boolean;

Eigenschaftswert

boolean

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.FontLoadOptions;

Eigenschaftswert

Hinweise

[ API-Satz: WordApi 1.1 ]

id

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

id?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApi 1.1 ]

parentBody

Ruft den übergeordneten Text des Inhaltssteuerelements ab.

parentBody?: Word.Interfaces.BodyLoadOptions;

Eigenschaftswert

Hinweise

[ API-Satz: WordApi 1.3 ]

parentContentControl

Ruft das Inhaltssteuerelement ab, das das Inhaltssteuerelement enthält. Löst einen Fehler aus ItemNotFound , wenn kein übergeordnetes Inhaltssteuerelement vorhanden ist.

parentContentControl?: Word.Interfaces.ContentControlLoadOptions;

Eigenschaftswert

Hinweise

[ API-Satz: WordApi 1.1 ]

parentContentControlOrNullObject

Ruft das Inhaltssteuerelement ab, das das Inhaltssteuerelement enthält. Wenn kein übergeordnetes Inhaltssteuerelement vorhanden ist, gibt diese Methode ein Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;

Eigenschaftswert

Hinweise

[ API-Satz: WordApi 1.3 ]

parentTable

Ruft die Tabelle ab, die das Inhaltssteuerelement enthält. Löst einen Fehler aus ItemNotFound , wenn er nicht in einer Tabelle enthalten ist.

parentTable?: Word.Interfaces.TableLoadOptions;

Eigenschaftswert

Hinweise

[ API-Satz: WordApi 1.3 ]

parentTableCell

Ruft die Tabellenzelle ab, die das Inhaltssteuerelement enthält. Löst einen Fehler aus ItemNotFound , wenn er nicht in einer Tabellenzelle enthalten ist.

parentTableCell?: Word.Interfaces.TableCellLoadOptions;

Eigenschaftswert

Hinweise

[ API-Satz: WordApi 1.3 ]

parentTableCellOrNullObject

Ruft die Tabellenzelle ab, die das Inhaltssteuerelement enthält. Wenn sie nicht in einer Tabellenzelle enthalten ist, gibt diese Methode ein Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;

Eigenschaftswert

Hinweise

[ API-Satz: WordApi 1.3 ]

parentTableOrNullObject

Ruft die Tabelle ab, die das Inhaltssteuerelement enthält. Wenn sie nicht in einer Tabelle enthalten ist, gibt diese Methode ein -Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;

Eigenschaftswert

Hinweise

[ API-Satz: WordApi 1.3 ]

placeholderText

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

placeholderText?: boolean;

Eigenschaftswert

boolean

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?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApi 1.1 ]

styleBuiltIn

Gibt den integrierten Formatvorlagennamen für das Inhaltssteuerelement an. Verwenden Sie diese Eigenschaft für integrierte Formatvorlagen, die zwischen Gebietsschemas portabel sind. Informationen zum Verwenden benutzerdefinierter Formatvorlagen oder lokalisierter Namen finden Sie unter der Eigenschaft "style".

styleBuiltIn?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApi 1.3 ]

subtype

Ruft den Untertyp des Inhaltssteuerelements ab. Der Untertyp kann "RichTextInline", "RichTextParagraphs", "RichTextTableCell", "RichTextTableRow" und "RichTextTable" für Rich-Text-Inhaltssteuerelemente oder "PlainTextInline" und "PlainTextParagraph" für Nur-Text-Inhaltssteuerelemente oder "CheckBox" für Kontrollkästcheninhaltssteuerelemente sein.

subtype?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApi 1.3 ]

tag

Gibt ein Tag zum Identifizieren eines Inhaltssteuerelements an.

tag?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApi 1.1 ]

text

Ruft den Text des Inhaltssteuerelements ab.

text?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApi 1.1 ]

title

Gibt den Titel für ein Inhaltssteuerelement an.

title?: boolean;

Eigenschaftswert

boolean

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?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApi 1.1 ]