Word.ShadowFormat class
Stellt die Schattenformatierung für eine Form oder einen Text in Word dar.
- Extends
Hinweise
Eigenschaften
| blur | Gibt die Weichzeichnerstufe für ein Schattenformat als Wert zwischen 0,0 und 100,0 an. |
| context | Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| foreground |
Gibt ein |
| is |
Gibt an, ob das Objekt oder die darauf angewendete Formatierung sichtbar ist. |
| obscured | Gibt an |
| offsetX | Gibt den horizontalen Offset (in Punkt) des Schattens von der Form an. Bei einem positiven Wert wird der Schatten auf die rechte Seite der Form versetzt, bei Verwendung eines negativen Werts erfolgt die Versetzung auf die linke Seite. |
| offsetY | Gibt den vertikalen Offset (in Punkt) des Schattens von der Form an. Ein positiver Wert versetzt den Schatten zum oberen Rand der Form; ein negativer Wert versetzt ihn nach unten. |
| rotate |
Gibt an, ob der Schatten beim Drehen der Form gedreht werden soll. |
| size | Gibt die Breite des Schattens an. |
| style | Gibt den Typ der Schattenformatierung an, die auf eine Form angewendet werden soll. |
| transparency | Gibt den Transparenzgrad des Schattens als Wert zwischen 0,0 (undurchsichtig) und 1,0 (klar) an. |
| type | Gibt den Typ des Formschattens an. |
Methoden
| increment |
Ändert den horizontalen Offset des Schattens um die Anzahl der Punkte. Inkrement Die Anzahl der anzupassenden Punkte. |
| increment |
Ändert den vertikalen Offset des Schattens um die angegebene Punktzahl. Inkrement Die Anzahl der anzupassenden Punkte. |
| 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. |
| 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 über |
| 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 aufrufen |
Details zur Eigenschaft
blur
Gibt die Weichzeichnerstufe für ein Schattenformat als Wert zwischen 0,0 und 100,0 an.
blur: number;Eigenschaftswert
number
Hinweise
context
Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
context: RequestContext;Eigenschaftswert
foregroundColor
Gibt ein ColorFormat -Objekt zurück, das die Vordergrundfarbe für die Füllung, Die Linie oder den Schatten darstellt.
readonly foregroundColor: Word.ColorFormat;Eigenschaftswert
Hinweise
isVisible
Gibt an, ob das Objekt oder die darauf angewendete Formatierung sichtbar ist.
isVisible: boolean;Eigenschaftswert
boolean
Hinweise
obscured
Gibt an true , ob der Schatten der Form ausgefüllt erscheint und von der Form verdeckt wird, auch wenn die Form keine Füllung hat, false wenn der Schatten keine Füllung hat und die Kontur des Schattens durch die Form sichtbar ist, wenn die Form keine Füllung hat.
obscured: boolean;Eigenschaftswert
boolean
Hinweise
offsetX
Gibt den horizontalen Offset (in Punkt) des Schattens von der Form an. Bei einem positiven Wert wird der Schatten auf die rechte Seite der Form versetzt, bei Verwendung eines negativen Werts erfolgt die Versetzung auf die linke Seite.
offsetX: number;Eigenschaftswert
number
Hinweise
offsetY
Gibt den vertikalen Offset (in Punkt) des Schattens von der Form an. Ein positiver Wert versetzt den Schatten zum oberen Rand der Form; ein negativer Wert versetzt ihn nach unten.
offsetY: number;Eigenschaftswert
number
Hinweise
rotateWithShape
Gibt an, ob der Schatten beim Drehen der Form gedreht werden soll.
rotateWithShape: boolean;Eigenschaftswert
boolean
Hinweise
size
Gibt die Breite des Schattens an.
size: number;Eigenschaftswert
number
Hinweise
style
Gibt den Typ der Schattenformatierung an, die auf eine Form angewendet werden soll.
style: Word.ShadowStyle | "Mixed" | "OuterShadow" | "InnerShadow";Eigenschaftswert
Word.ShadowStyle | "Mixed" | "OuterShadow" | "InnerShadow"
Hinweise
transparency
Gibt den Transparenzgrad des Schattens als Wert zwischen 0,0 (undurchsichtig) und 1,0 (klar) an.
transparency: number;Eigenschaftswert
number
Hinweise
type
Gibt den Typ des Formschattens an.
type: Word.ShadowType | "Mixed" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9" | "Type10" | "Type11" | "Type12" | "Type13" | "Type14" | "Type15" | "Type16" | "Type17" | "Type18" | "Type19" | "Type20" | "Type21" | "Type22" | "Type23" | "Type24" | "Type25" | "Type26" | "Type27" | "Type28" | "Type29" | "Type30" | "Type31" | "Type32" | "Type33" | "Type34" | "Type35" | "Type36" | "Type37" | "Type38" | "Type39" | "Type40" | "Type41" | "Type42" | "Type43";Eigenschaftswert
Word.ShadowType | "Mixed" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9" | "Type10" | "Type11" | "Type12" | "Type13" | "Type14" | "Type15" | "Type16" | "Type17" | "Type18" | "Type19" | "Type20" | "Type21" | "Type22" | "Type23" | "Type24" | "Type25" | "Type26" | "Type27" | "Type28" | "Type29" | "Type30" | "Type31" | "Type32" | "Type33" | "Type34" | "Type35" | "Type36" | "Type37" | "Type38" | "Type39" | "Type40" | "Type41" | "Type42" | "Type43"
Hinweise
Details zur Methode
incrementOffsetX(increment)
Ändert den horizontalen Offset des Schattens um die Anzahl der Punkte. Inkrement Die Anzahl der anzupassenden Punkte.
incrementOffsetX(increment: number): void;Parameter
- increment
-
number
Gibt zurück
void
Hinweise
incrementOffsetY(increment)
Ändert den vertikalen Offset des Schattens um die angegebene Punktzahl. Inkrement Die Anzahl der anzupassenden Punkte.
incrementOffsetY(increment: number): void;Parameter
- increment
-
number
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.ShadowFormatLoadOptions): Word.ShadowFormat;Parameter
Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.
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.ShadowFormat;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.ShadowFormat;Parameter
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select ist eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Trennzeichen 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.ShadowFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;Parameter
- properties
- Word.Interfaces.ShadowFormatUpdateData
Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.
- options
- OfficeExtension.UpdateOptions
Stellt eine Option zum Unterdrücken von Fehlern bereit, wenn das Eigenschaftenobjekt 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.ShadowFormat): void;Parameter
- properties
- Word.ShadowFormat
Gibt zurück
void
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 das Objekt übergeben wird.) Während das ursprüngliche Word.ShadowFormat Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Word.Interfaces.ShadowFormatData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.
toJSON(): Word.Interfaces.ShadowFormatData;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 über .sync Aufrufe hinweg 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 den Fehler "InvalidObjectPath" erhalten, müssen Sie das Objekt der nachverfolgten Objektauflistung hinzufügen, als das Objekt zum ersten Mal erstellt wurde. Wenn dieses Objekt Teil einer Auflistung ist, sollten Sie auch die übergeordnete Auflistung nachverfolgen.
track(): Word.ShadowFormat;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 aufrufen context.sync() , bevor die Speicherfreigabe wirksam wird.
untrack(): Word.ShadowFormat;