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-, Kontrollkästchen-, Dropdownlisten- und Kombinationsfeld-Inhaltssteuerelemente unterstützt.

Eigenschaften

$all

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

appearance

Gibt die Darstellung des Inhaltssteuerelements an. Der Wert kann ,tags oderhidden seinboundingBox.

buildingBlockGalleryContentControl

Ruft die Daten zum Bausteinkatalog ab, wenn das Inhaltssteuerelement Word ist. ContentControlType ist buildingBlockGallery. Es ist null anders.

cannotDelete

Gibt an, ob der Benutzer das Inhaltssteuerelement löschen kann. Schließt sich gegenseitig mit removeWhenEditedaus.

cannotEdit

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

checkboxContentControl

Ruft die Daten des Inhaltssteuerelements ab, wenn sein Typ ist checkBox. Es ist null anders.

color

Gibt die Farbe des Inhaltssteuerelements an. Die Farbe wird im Format '#RRGGBB' oder mithilfe des Farbnamens angegeben.

datePickerContentControl

Ruft die Daten zur Datumsauswahl ab, wenn es sich bei dem Inhaltssteuerelement um Word handelt. ContentControlType ist datePicker. Es ist null anders.

font

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

groupContentControl

Ruft die gruppenbezogenen Daten ab, wenn das Inhaltssteuerelement Word ist. ContentControlType ist group. Es ist null anders.

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. Gibt einen ItemNotFound Fehler aus, 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 festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

parentTable

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

parentTableCell

Ruft die Tabellenzelle ab, die das Inhaltssteuerelement enthält. Gibt einen ItemNotFound Fehler aus, 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 festgelegt ist true. 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 festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

pictureContentControl

Ruft die bildbezogenen Daten ab, wenn das Inhaltssteuerelement Word ist. ContentControlType ist picture. Es ist null anders.

placeholderText

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

removeWhenEdited

Gibt an, ob das Inhaltssteuerelement nach der Bearbeitung entfernt wird. Schließt sich gegenseitig mit cannotDeleteaus.

repeatingSectionContentControl

Ruft die Daten zu wiederholten Abschnitten ab, wenn das Inhaltssteuerelement Word ist. ContentControlType ist repeatingSection. Es ist null anders.

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 portierbar sind, finden Sie in der styleBuiltIn Eigenschaft.

styleBuiltIn

Gibt den vordefinierten Formatvorlagennamen für das Inhaltssteuerelement an. Verwenden Sie diese Eigenschaft für integrierte Formatvorlagen, die zwischen Gebietsschemas portabel sind. Informationen zum Verwenden von benutzerdefinierten Formatvorlagen oder lokalisierten Formatvorlagennamen finden Sie in der style Eigenschaft.

subtype

Ruft den Untertyp des Inhaltssteuerelements ab. Der Untertyp kann ", richTextParagraphs, richTextTableCellrichTextTableRow" sein und richTextTable für Rich-Text-Inhaltssteuerelemente plainTextInline sowie plainTextParagraph für Nur-Text-InhaltssteuerelementerichTextInline, checkBox für Kontrollkästchen-Inhaltssteuerelemente, dropDownList für Dropdownlisten-Inhaltssteuerelemente, für Kombinationsfeld-Inhaltssteuerelemente, buildingBlockGallerycomboBox für Bausteinkatalog-Inhaltssteuerelemente, datePicker für Datumsauswahl-Inhaltssteuerelemente, repeatingSection für Inhaltssteuerelemente für wiederholte Abschnitte, picture für Bild-Inhaltssteuerelemente und group für Gruppeninhaltssteuerelemente.

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-, Kontrollkästchen-, Dropdownlisten-, Kombinationsfeld-, Bausteinkatalog-, Datumsauswahl-, Wiederholte Abschnitt-, Bild- und Gruppeninhaltssteuerelemente unterstützt.

xmlMapping

Gibt ein XmlMapping Objekt zurück, das die Zuordnung des Inhaltssteuerelements zu XML-Daten im Datenspeicher des Dokuments darstellt.

Details zur Eigenschaft

$all

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

$all?: boolean;

Eigenschaftswert

boolean

appearance

Gibt die Darstellung des Inhaltssteuerelements an. Der Wert kann ,tags oderhidden seinboundingBox.

appearance?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: WordApi 1.1

buildingBlockGalleryContentControl

Ruft die Daten zum Bausteinkatalog ab, wenn das Inhaltssteuerelement Word ist. ContentControlType ist buildingBlockGallery. Es ist null anders.

buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlLoadOptions;

Eigenschaftswert

Hinweise

API-Satz: WordApiDesktop 1.3

cannotDelete

Gibt an, ob der Benutzer das Inhaltssteuerelement löschen kann. Schließt sich gegenseitig mit removeWhenEditedaus.

cannotDelete?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: WordApi 1.1

cannotEdit

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

cannotEdit?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: WordApi 1.1

checkboxContentControl

Ruft die Daten des Inhaltssteuerelements ab, wenn sein Typ ist checkBox. Es ist null anders.

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 mithilfe des Farbnamens angegeben.

color?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: WordApi 1.1

datePickerContentControl

Ruft die Daten zur Datumsauswahl ab, wenn es sich bei dem Inhaltssteuerelement um Word handelt. ContentControlType ist datePicker. Es ist null anders.

datePickerContentControl?: Word.Interfaces.DatePickerContentControlLoadOptions;

Eigenschaftswert

Hinweise

API-Satz: WordApiDesktop 1.3

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

groupContentControl

Ruft die gruppenbezogenen Daten ab, wenn das Inhaltssteuerelement Word ist. ContentControlType ist group. Es ist null anders.

groupContentControl?: Word.Interfaces.GroupContentControlLoadOptions;

Eigenschaftswert

Hinweise

API-Satz: WordApiDesktop 1.3

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. Gibt einen ItemNotFound Fehler aus, 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 festgelegt ist true. 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. Gibt einen ItemNotFound Fehler aus, 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. Gibt einen ItemNotFound Fehler aus, 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 festgelegt ist true. 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 festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;

Eigenschaftswert

Hinweise

API-Satz: WordApi 1.3

pictureContentControl

Ruft die bildbezogenen Daten ab, wenn das Inhaltssteuerelement Word ist. ContentControlType ist picture. Es ist null anders.

pictureContentControl?: Word.Interfaces.PictureContentControlLoadOptions;

Eigenschaftswert

Hinweise

API-Satz: WordApiDesktop 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 an, ob das Inhaltssteuerelement nach der Bearbeitung entfernt wird. Schließt sich gegenseitig mit cannotDeleteaus.

removeWhenEdited?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: WordApi 1.1

repeatingSectionContentControl

Ruft die Daten zu wiederholten Abschnitten ab, wenn das Inhaltssteuerelement Word ist. ContentControlType ist repeatingSection. Es ist null anders.

repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlLoadOptions;

Eigenschaftswert

Hinweise

API-Satz: WordApiDesktop 1.3

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 portierbar sind, finden Sie in der styleBuiltIn Eigenschaft.

style?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: WordApi 1.1

styleBuiltIn

Gibt den vordefinierten Formatvorlagennamen für das Inhaltssteuerelement an. Verwenden Sie diese Eigenschaft für integrierte Formatvorlagen, die zwischen Gebietsschemas portabel sind. Informationen zum Verwenden von benutzerdefinierten Formatvorlagen oder lokalisierten Formatvorlagennamen finden Sie in der style Eigenschaft.

styleBuiltIn?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: WordApi 1.3

subtype

Ruft den Untertyp des Inhaltssteuerelements ab. Der Untertyp kann ", richTextParagraphs, richTextTableCellrichTextTableRow" sein und richTextTable für Rich-Text-Inhaltssteuerelemente plainTextInline sowie plainTextParagraph für Nur-Text-InhaltssteuerelementerichTextInline, checkBox für Kontrollkästchen-Inhaltssteuerelemente, dropDownList für Dropdownlisten-Inhaltssteuerelemente, für Kombinationsfeld-Inhaltssteuerelemente, buildingBlockGallerycomboBox für Bausteinkatalog-Inhaltssteuerelemente, datePicker für Datumsauswahl-Inhaltssteuerelemente, repeatingSection für Inhaltssteuerelemente für wiederholte Abschnitte, picture für Bild-Inhaltssteuerelemente und group für Gruppeninhaltssteuerelemente.

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-, Kontrollkästchen-, Dropdownlisten-, Kombinationsfeld-, Bausteinkatalog-, Datumsauswahl-, Wiederholte Abschnitt-, Bild- und Gruppeninhaltssteuerelemente unterstützt.

type?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: WordApi 1.1

xmlMapping

Gibt ein XmlMapping Objekt zurück, das die Zuordnung des Inhaltssteuerelements zu XML-Daten im Datenspeicher des Dokuments darstellt.

xmlMapping?: Word.Interfaces.XmlMappingLoadOptions;

Eigenschaftswert

Hinweise

API-Satz: WordApiDesktop 1.3