Partager via


Word.LineFormat class

Représente la ligne et la mise en forme de la pointe de flèche. Pour une ligne, l’objet contient des LineFormat informations de mise en forme pour la ligne elle-même ; pour une forme avec une bordure, cet objet contient des informations de mise en forme pour la bordure de la forme.

Extends

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Propriétés

backgroundColor

Obtient un ColorFormat objet qui représente la couleur d’arrière-plan d’une ligne à motifs.

beginArrowheadLength

Spécifie la longueur de la pointe de flèche au début de la ligne.

beginArrowheadStyle

Spécifie le style de la pointe de flèche au début de la ligne.

beginArrowheadWidth

Spécifie la largeur de la pointe de flèche au début de la ligne.

context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.

dashStyle

Spécifie le style de tiret de la ligne.

endArrowheadLength

Spécifie la longueur de la pointe de flèche à la fin de la ligne.

endArrowheadStyle

Spécifie le style de la pointe de flèche à la fin de la ligne.

endArrowheadWidth

Spécifie la largeur de la pointe de flèche à la fin de la ligne.

foregroundColor

Obtient un ColorFormat objet qui représente la couleur de premier plan de la ligne.

insetPen

Spécifie s’il faut dessiner des lignes à l’intérieur d’une forme.

isVisible

Spécifie si l’objet, ou la mise en forme qui lui est appliquée, est visible.

pattern

Spécifie le modèle appliqué à la ligne.

style

Spécifie le style de format de ligne.

transparency

Spécifie le degré de transparence de la ligne sous la forme d’une valeur comprise entre 0,0 (opaque) et 1,0 (clair).

weight

Spécifie l’épaisseur de la ligne en points.

Méthodes

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

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.

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.LineFormat est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Word.Interfaces.LineFormatDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

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.

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.

Détails de la propriété

backgroundColor

Obtient un ColorFormat objet qui représente la couleur d’arrière-plan d’une ligne à motifs.

readonly backgroundColor: Word.ColorFormat;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

beginArrowheadLength

Spécifie la longueur de la pointe de flèche au début de la ligne.

beginArrowheadLength: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long";

Valeur de propriété

Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

beginArrowheadStyle

Spécifie le style de la pointe de flèche au début de la ligne.

beginArrowheadStyle: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval";

Valeur de propriété

Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

beginArrowheadWidth

Spécifie la largeur de la pointe de flèche au début de la ligne.

beginArrowheadWidth: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide";

Valeur de propriété

Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

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é

dashStyle

Spécifie le style de tiret de la ligne.

dashStyle: Word.LineDashStyle | "Mixed" | "Solid" | "SquareDot" | "RoundDot" | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "LongDashDotDot" | "SysDash" | "SysDot" | "SysDashDot";

Valeur de propriété

Word.LineDashStyle | "Mixed" | "Solid" | "SquareDot" | "RoundDot" | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "LongDashDotDot" | "SysDash" | "SysDot" | "SysDashDot"

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

endArrowheadLength

Spécifie la longueur de la pointe de flèche à la fin de la ligne.

endArrowheadLength: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long";

Valeur de propriété

Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

endArrowheadStyle

Spécifie le style de la pointe de flèche à la fin de la ligne.

endArrowheadStyle: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval";

Valeur de propriété

Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

endArrowheadWidth

Spécifie la largeur de la pointe de flèche à la fin de la ligne.

endArrowheadWidth: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide";

Valeur de propriété

Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

foregroundColor

Obtient un ColorFormat objet qui représente la couleur de premier plan de la ligne.

readonly foregroundColor: Word.ColorFormat;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

insetPen

Spécifie s’il faut dessiner des lignes à l’intérieur d’une forme.

insetPen: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

isVisible

Spécifie si l’objet, ou la mise en forme qui lui est appliquée, est visible.

isVisible: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

pattern

Spécifie le modèle appliqué à la ligne.

pattern: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross";

Valeur de propriété

Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

style

Spécifie le style de format de ligne.

style: Word.LineFormatStyle | "Mixed" | "Single" | "ThinThin" | "ThinThick" | "ThickThin" | "ThickBetweenThin";

Valeur de propriété

Word.LineFormatStyle | "Mixed" | "Single" | "ThinThin" | "ThinThick" | "ThickThin" | "ThickBetweenThin"

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

transparency

Spécifie le degré de transparence de la ligne sous la forme d’une valeur comprise entre 0,0 (opaque) et 1,0 (clair).

transparency: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

weight

Spécifie l’épaisseur de la ligne en points.

weight: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApiDesktop 1.3 ]

Détails de la méthode

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.LineFormatLoadOptions): Word.LineFormat;

Paramètres

options
Word.Interfaces.LineFormatLoadOptions

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.LineFormat;

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.LineFormat;

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.LineFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

properties
Word.Interfaces.LineFormatUpdateData

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.LineFormat): void;

Paramètres

properties
Word.LineFormat

Retours

void

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.LineFormat est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Word.Interfaces.LineFormatDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): Word.Interfaces.LineFormatData;

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.LineFormat;

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.LineFormat;

Retours