Word.Interfaces.FieldLoadOptions interface

Stellt ein Feld dar.

Hinweise

[ API-Satz: WordApi 1.4 ]

Wichtig: Weitere Informationen dazu, welche Felder eingefügt werden können, finden Sie in der API, die Word.Range.insertField in Anforderungssatz 1.5 eingeführt wurde. Die Unterstützung für die Verwaltung von Feldern ähnelt dem, was auf der Word-Benutzeroberfläche verfügbar ist. Während die Word-Benutzeroberfläche im Web in erster Linie felder als schreibgeschützt unterstützt (siehe Feldfunktionen in Word für das Web), kann das Addin Feld bearbeitet werden. Weitere Informationen zu Word UI-Clients, die Felder vollständig unterstützen, finden Sie in der Produktliste am Anfang von Einfügen, Bearbeiten und Anzeigen von Feldern in Word.

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

code

Gibt die Codeanweisung des Felds an.

data

Gibt Daten in einem Addin-Feld an. Wenn es sich bei dem Feld nicht um ein "Addin"-Feld handelt, wird null eine allgemeine Ausnahme ausgelöst, wenn code versucht, es festzulegen.

kind

Ruft die Art des Felds ab.

locked

Gibt an, ob das Feld gesperrt ist. true , wenn das Feld gesperrt ist, andernfalls false .

parentBody

Ruft den übergeordneten Text des Felds ab.

parentContentControl

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

parentContentControlOrNullObject

Ruft das Inhaltssteuerelement ab, das das Feld 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 Feld enthält. Löst einen Fehler aus ItemNotFound , wenn er nicht in einer Tabelle enthalten ist.

parentTableCell

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

parentTableCellOrNullObject

Ruft die Tabellenzelle ab, die das Feld 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 Feld 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.

result

Ruft die Ergebnisdaten des Felds ab.

showCodes

Gibt an, ob die Feldfunktionen für das angegebene Feld angezeigt werden. true , wenn die Feldfunktionen angezeigt werden, false andernfalls.

type

Ruft den Typ des Felds ab.

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

code

Gibt die Codeanweisung des Felds an.

code?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApi 1.4 ]

Hinweis: Die Möglichkeit zum Festlegen des Codes wurde in WordApi 1.5 eingeführt.

data

Gibt Daten in einem Addin-Feld an. Wenn es sich bei dem Feld nicht um ein "Addin"-Feld handelt, wird null eine allgemeine Ausnahme ausgelöst, wenn code versucht, es festzulegen.

data?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApi 1.5 ]

kind

Ruft die Art des Felds ab.

kind?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApi 1.5 ]

locked

Gibt an, ob das Feld gesperrt ist. true , wenn das Feld gesperrt ist, andernfalls false .

locked?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApi 1.5 ]

parentBody

Ruft den übergeordneten Text des Felds ab.

parentBody?: Word.Interfaces.BodyLoadOptions;

Eigenschaftswert

Hinweise

[ API-Satz: WordApi 1.4 ]

parentContentControl

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

parentContentControl?: Word.Interfaces.ContentControlLoadOptions;

Eigenschaftswert

Hinweise

[ API-Satz: WordApi 1.4 ]

parentContentControlOrNullObject

Ruft das Inhaltssteuerelement ab, das das Feld 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.4 ]

parentTable

Ruft die Tabelle ab, die das Feld 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.4 ]

parentTableCell

Ruft die Tabellenzelle ab, die das Feld 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.4 ]

parentTableCellOrNullObject

Ruft die Tabellenzelle ab, die das Feld 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.4 ]

parentTableOrNullObject

Ruft die Tabelle ab, die das Feld 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.4 ]

result

Ruft die Ergebnisdaten des Felds ab.

result?: Word.Interfaces.RangeLoadOptions;

Eigenschaftswert

Hinweise

[ API-Satz: WordApi 1.4 ]

showCodes

Gibt an, ob die Feldfunktionen für das angegebene Feld angezeigt werden. true , wenn die Feldfunktionen angezeigt werden, false andernfalls.

showCodes?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApiDesktop 1.1 ]

type

Ruft den Typ des Felds ab.

type?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApi 1.5 ]