Word.ShadowFormat class
Stellt die Schattenformatierung für eine Form oder einen Text in Word dar.
- Extends
Eigenschaften
| blur | Gibt den Weichzeichnergrad für ein Schattenformat auf einen Wert zwischen 0,0 und 100,0 an. |
| context | Der dem Objekt zugeordnete Anforderungskontext. 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 Versatz (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 Versatz (in Punkt) des Schattens vom Shape an. Ein positiver Wert versetzt den Schatten bis zum oberen Rand der Form. Ein negativer Wert versetzt ihn nach unten. |
| rotate |
Gibt an, ob der Schatten beim Drehen des Shapes gedreht werden soll. |
| size | Legt die Breite des Schattens fest. |
| 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 Schattentyp der Form an. |
Methoden
| increment |
Ändert den horizontalen Versatz 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 aufrufübergreifend |
| 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 einen Aufruf durchführen |
Details zur Eigenschaft
blur
Gibt den Weichzeichnergrad für ein Schattenformat auf einen Wert zwischen 0,0 und 100,0 an.
blur: number;Eigenschaftswert
number
Hinweise
context
Der dem Objekt zugeordnete Anforderungskontext. 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 aufweist, wenn der Schatten keine Füllung aufweist und die Umrisse des Schattens durch die Form hindurch sichtbar sind, false wenn die Form keine Füllung aufweist.
obscured: boolean;Eigenschaftswert
boolean
Hinweise
offsetX
Gibt den horizontalen Versatz (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 Versatz (in Punkt) des Schattens vom Shape an. Ein positiver Wert versetzt den Schatten bis 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 des Shapes gedreht werden soll.
rotateWithShape: boolean;Eigenschaftswert
boolean
Hinweise
size
Legt die Breite des Schattens fest.
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 Schattentyp der Form 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 Versatz 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 für die zu ladenden Eigenschaften des Objekts bereit.
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 Kommas getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Kommas 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
Bietet eine Option zum Unterdrücken von Fehlern, wenn das properties-Objekt 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 sie übergeben wird.) Während das ursprüngliche Word.ShadowFormat Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Word.Interfaces.ShadowFormatData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts 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 aufrufübergreifend .sync 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 ein "InvalidObjectPath"-Fehler angezeigt wird, müssen Sie das Objekt der nachverfolgten Objektsammlung hinzufügen, wenn das Objekt zum ersten Mal erstellt wurde. Wenn dieses Objekt Teil einer Sammlung ist, sollten Sie auch die übergeordnete Sammlung 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 einen Aufruf durchführen context.sync() , bevor die Speicherfreigabe wirksam wird.
untrack(): Word.ShadowFormat;