Word.ShapeFill class
Représente la mise en forme de remplissage d’un objet shape.
- Extends
Remarques
[ Ensemble d’API : WordApiDesktop 1.2 ]
Propriétés
| background |
Spécifie la couleur d’arrière-plan de remplissage de la forme. Vous pouvez fournir la valeur au format « #RRGGBB » ou le nom de la couleur. |
| context | Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office. |
| foreground |
Spécifie la couleur de premier plan du remplissage de la forme. Vous pouvez fournir la valeur au format « #RRGGBB » ou le nom de la couleur. |
| transparency | Spécifie le pourcentage de transparence du remplissage sous la forme d’une valeur comprise entre 0,0 (opaque) et 1,0 (clair). Renvoie |
| type | Renvoie le type de remplissage de la forme. Pour plus d’informations, consultez |
Méthodes
| clear() | Efface la mise en forme de remplissage de cette forme et la définit sur |
| load(options) | Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| set(properties, options) | Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type. |
| set(properties) | Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant. |
| set |
Définit le format de remplissage d’un élément de graphique sur une couleur unie. Cela remplace le type de remplissage par |
| toJSON() | Remplace la méthode JavaScript |
| track() | Effectuer le suivi de l’objet pour l’ajustement automatique en fonction environnant des modifications dans le document. Cet appel est un raccourci pour context.trackedObjects.add(thisObject). Si vous utilisez cet objet sur des |
| untrack() | Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est abrégé pour context.trackedObjects.remove(thisObject). Vous rencontrez de nombreux objets suivies ralentit l’application hôte, donc n’oubliez pas de libérer les objets que l'on ajoute, une fois que vous avez terminé à les utiliser. Vous devez appeler |
Détails de la propriété
backgroundColor
Spécifie la couleur d’arrière-plan de remplissage de la forme. Vous pouvez fournir la valeur au format « #RRGGBB » ou le nom de la couleur.
backgroundColor: string;Valeur de propriété
string
Remarques
context
Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
context: RequestContext;Valeur de propriété
foregroundColor
Spécifie la couleur de premier plan du remplissage de la forme. Vous pouvez fournir la valeur au format « #RRGGBB » ou le nom de la couleur.
foregroundColor: string;Valeur de propriété
string
Remarques
transparency
Spécifie le pourcentage de transparence du remplissage sous la forme d’une valeur comprise entre 0,0 (opaque) et 1,0 (clair). Renvoie null si le type de forme ne prend pas en charge la transparence ou si le remplissage de la forme présente une transparence incohérente, par exemple avec un type de remplissage dégradé.
transparency: number;Valeur de propriété
number
Remarques
type
Renvoie le type de remplissage de la forme. Pour plus d’informations, consultez Word.ShapeFillType .
readonly type: Word.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "Picture" | "Texture" | "Mixed";Valeur de propriété
Word.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "Picture" | "Texture" | "Mixed"
Remarques
Détails de la méthode
clear()
Efface la mise en forme de remplissage de cette forme et la définit sur Word.ShapeFillType.NoFill;
clear(): void;Retours
void
Remarques
load(options)
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(options?: Word.Interfaces.ShapeFillLoadOptions): Word.ShapeFill;Paramètres
Fournit des options pour les propriétés de l’objet à charger.
Retours
load(propertyNames)
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(propertyNames?: string | string[]): Word.ShapeFill;Paramètres
- propertyNames
-
string | string[]
Chaîne délimitée par des virgules ou tableau de chaînes qui spécifient les propriétés à charger.
Retours
load(propertyNamesAndPaths)
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.ShapeFill;Paramètres
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et propertyNamesAndPaths.expand est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.
Retours
set(properties, options)
Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.
set(properties: Interfaces.ShapeFillUpdateData, options?: OfficeExtension.UpdateOptions): void;Paramètres
- properties
- Word.Interfaces.ShapeFillUpdateData
Objet JavaScript avec des propriétés qui sont structurées isomorphes en fonction des propriétés de l’objet sur lequel la méthode est appelée.
- options
- OfficeExtension.UpdateOptions
Fournit une option permettant de supprimer les erreurs si l’objet properties tente de définir des propriétés en lecture seule.
Retours
void
set(properties)
Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.
set(properties: Word.ShapeFill): void;Paramètres
- properties
- Word.ShapeFill
Retours
void
setSolidColor(color)
Définit le format de remplissage d’un élément de graphique sur une couleur unie. Cela remplace le type de remplissage par Word.ShapeFillType.Solid.
setSolidColor(color: string): void;Paramètres
- color
-
string
Chaîne qui représente la couleur de premier plan de remplissage. Vous pouvez fournir la valeur au format « #RRGGBB » ou le nom de la couleur.
Retours
void
Remarques
toJSON()
Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Word.ShapeFill est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Word.Interfaces.ShapeFillDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.
toJSON(): Word.Interfaces.ShapeFillData;Retours
track()
Effectuer le suivi de l’objet pour l’ajustement automatique en fonction environnant des modifications dans le document. Cet appel est un raccourci pour context.trackedObjects.add(thisObject). Si vous utilisez cet objet sur des .sync appels et en dehors de l’exécution séquentielle d’un lot « .run », et que vous obtenez une erreur « InvalidObjectPath » lors de la définition d’une propriété ou de l’appel d’une méthode sur l’objet, vous devez ajouter l’objet à la collection d’objets suivie lors de la première création de l’objet. Si cet objet fait partie d’une collection, vous devez également suivre la collection parente.
track(): Word.ShapeFill;Retours
untrack()
Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est abrégé pour context.trackedObjects.remove(thisObject). Vous rencontrez de nombreux objets suivies ralentit l’application hôte, donc n’oubliez pas de libérer les objets que l'on ajoute, une fois que vous avez terminé à les utiliser. Vous devez appeler context.sync() avant que la mise en production de la mémoire ne prenne effet.
untrack(): Word.ShapeFill;