Word.FillFormat class

Devolve um ColorFormat objeto que representa a cor de fundo do preenchimento.

readonly backgroundColor: Word.ColorFormat;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.

context: RequestContext;

Valor da propriedade

Devolve um ColorFormat objeto que representa a cor de primeiro plano para o preenchimento.

readonly foregroundColor: Word.ColorFormat;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Especifica o ângulo do preenchimento com gradação. O intervalo de valores válido é de 0 a 359,9.

gradientAngle: number;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Obtém o tipo de cor de gradação.

readonly gradientColorType: Word.GradientColorType | "Mixed" | "OneColor" | "TwoColors" | "PresetColors" | "MultiColor";

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Devolve o quão escuro ou claro é um preenchimento de gradação de uma cor. Um valor de 0 significa que o preto é misturado com a cor de primeiro plano da forma para formar a gradação. Um valor de 1 significa que o branco está misturado. Os valores entre 0 e 1 significam que um tom mais escuro ou mais claro da cor de primeiro plano é misturado.

readonly gradientDegree: number;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Devolve o estilo de gradação para o preenchimento.

readonly gradientStyle: Word.GradientStyle | "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter";

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Devolve a variante de gradação para o preenchimento como um valor inteiro de 1 a 4 para a maioria dos preenchimentos de gradação.

readonly gradientVariant: number;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Especifica se o objeto ou a formatação aplicada ao mesmo está visível.

isVisible: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Devolve um PatternType valor que representa o padrão aplicado ao preenchimento ou linha.

readonly 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";

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Devolve o tipo de gradação predefinido para o preenchimento.

readonly presetGradientType: Word.PresetGradientType | "Mixed" | "EarlySunset" | "LateSunset" | "Nightfall" | "Daybreak" | "Horizon" | "Desert" | "Ocean" | "CalmWater" | "Fire" | "Fog" | "Moss" | "Peacock" | "Wheat" | "Parchment" | "Mahogany" | "Rainbow" | "RainbowII" | "Gold" | "GoldII" | "Brass" | "Chrome" | "ChromeII" | "Silver" | "Sapphire";

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Obtém a textura predefinida.

readonly presetTexture: Word.PresetTexture | "Mixed" | "Papyrus" | "Canvas" | "Denim" | "WovenMat" | "WaterDroplets" | "PaperBag" | "FishFossil" | "Sand" | "GreenMarble" | "WhiteMarble" | "BrownMarble" | "Granite" | "Newsprint" | "RecycledPaper" | "Parchment" | "Stationery" | "BlueTissuePaper" | "PinkTissuePaper" | "PurpleMesh" | "Bouquet" | "Cork" | "Walnut" | "Oak" | "MediumWood";

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Especifica se o preenchimento roda com a forma.

rotateWithObject: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Especifica o alinhamento (a origem da grade de coordenadas) para a colocação lado a lado do preenchimento com textura.

textureAlignment: Word.TextureAlignment | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "Center" | "Right" | "BottomLeft" | "Bottom" | "BottomRight";

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Especifica o fator de dimensionamento horizontal para o preenchimento com textura.

textureHorizontalScale: number;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Devolve o nome do ficheiro de textura personalizada para o preenchimento.

readonly textureName: string;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Especifica o deslocamento horizontal da textura da origem em pontos.

textureOffsetX: number;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Especifica o deslocamento vertical da textura.

textureOffsetY: number;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Especifica se a textura é em mosaico.

textureTile: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Devolve o tipo de textura para o preenchimento.

readonly textureType: Word.TextureType | "Mixed" | "Preset" | "UserDefined";

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Especifica o fator de dimensionamento vertical para o preenchimento com textura como um valor entre 0,0 e 1,0.

textureVerticalScale: number;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Especifica o grau de transparência do preenchimento de uma forma como um valor entre 0,0 (opaco) e 1,0 (claro).

transparency: number;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Obtém o tipo de formato de preenchimento.

readonly type: Word.FillType | "Mixed" | "Solid" | "Patterned" | "Gradient" | "Textured" | "Background" | "Picture";

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(options?: Word.Interfaces.FillFormatLoadOptions): Word.FillFormat;

Parâmetros

Retornos

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNames?: string | string[]): Word.FillFormat;

Parâmetros

Retornos

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.FillFormat;

Parâmetros

Retornos

Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.

set(properties: Interfaces.FillFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

Retornos

Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.

set(properties: Word.FillFormat): void;

Parâmetros

Retornos

Define o preenchimento para uma gradação de uma cor.

setOneColorGradient(style: Word.GradientStyle, variant: number, degree: number): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Define o preenchimento para uma gradação de uma cor.

setOneColorGradient(style: "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter", variant: number, degree: number): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Define o preenchimento como um padrão.

setPatterned(pattern: Word.PatternType): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Define o preenchimento como um padrão.

setPatterned(pattern: "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"): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Define o preenchimento para uma gradação predefinida. O estilo de gradação. A variante de gradação. Pode ser um valor de 1 a 4. O tipo de gradação predefinido.

setPresetGradient(style: Word.GradientStyle, variant: number, presetGradientType: Word.PresetGradientType): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Define o preenchimento para uma gradação predefinida. O estilo de gradação. A variante de gradação. Pode ser um valor de 1 a 4. O tipo de gradação predefinido.

setPresetGradient(style: "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter", variant: number, presetGradientType: "Mixed" | "EarlySunset" | "LateSunset" | "Nightfall" | "Daybreak" | "Horizon" | "Desert" | "Ocean" | "CalmWater" | "Fire" | "Fog" | "Moss" | "Peacock" | "Wheat" | "Parchment" | "Mahogany" | "Rainbow" | "RainbowII" | "Gold" | "GoldII" | "Brass" | "Chrome" | "ChromeII" | "Silver" | "Sapphire"): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Define o preenchimento para uma textura predefinida.

setPresetTextured(presetTexture: Word.PresetTexture): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Define o preenchimento para uma textura predefinida.

setPresetTextured(presetTexture: "Mixed" | "Papyrus" | "Canvas" | "Denim" | "WovenMat" | "WaterDroplets" | "PaperBag" | "FishFossil" | "Sand" | "GreenMarble" | "WhiteMarble" | "BrownMarble" | "Granite" | "Newsprint" | "RecycledPaper" | "Parchment" | "Stationery" | "BlueTissuePaper" | "PinkTissuePaper" | "PurpleMesh" | "Bouquet" | "Cork" | "Walnut" | "Oak" | "MediumWood"): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Define o preenchimento para uma gradação de duas cores.

setTwoColorGradient(style: Word.GradientStyle, variant: number): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Define o preenchimento para uma gradação de duas cores.

setTwoColorGradient(style: "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter", variant: number): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Define o preenchimento para uma cor uniforme.

solid(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Word.FillFormat é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Word.Interfaces.FillFormatData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): Word.Interfaces.FillFormatData;

Retornos

Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Esta chamada é uma abreviatura de context.trackedObjects.add(thisObject). Se estiver a utilizar este objeto entre .sync chamadas e fora da execução sequencial de um lote ".run" e receber um erro "InvalidObjectPath" ao definir uma propriedade ou invocar um método no objeto, terá de adicionar o objeto à coleção de objetos controlados quando o objeto foi criado pela primeira vez. Se este objeto fizer parte de uma coleção, também deve controlar a coleção principal.

track(): Word.FillFormat;

Retornos

Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Esta chamada é abreviada para context.trackedObjects.remove(thisObject). Ter muitos objetos rastreados desacelera o aplicativo host, por isso, lembre-se de liberar todos os objetos adicionados após usá-los. Terá de chamar context.sync() antes de a libertação da memória ser aplicada.

untrack(): Word.FillFormat;

Retornos