Word.FillFormat class

Devuelve un ColorFormat objeto que representa el color de fondo del relleno.

readonly backgroundColor: Word.ColorFormat;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

Devuelve un ColorFormat objeto que representa el color de primer plano del relleno.

readonly foregroundColor: Word.ColorFormat;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Especifica el ángulo del relleno degradado. El rango de valores válido va de 0 a 359,9.

gradientAngle: number;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Obtiene el tipo de color degradado.

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

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Devuelve el nivel de oscuridad o claro que es un relleno degradado de un color. Un valor de 0 significa que el negro se mezcla con el color de primer plano de la forma para formar el degradado. Un valor de 1 significa que se mezcla blanca. Un valor entre 0 y 1 significa que se mezcla un tono más oscuro o más claro del color de primer plano.

readonly gradientDegree: number;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Devuelve el estilo de degradado del relleno.

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

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Devuelve la variante de degradado del relleno como un valor entero de 1 a 4 para la mayoría de los rellenos de degradado.

readonly gradientVariant: number;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Especifica si el objeto, o el formato que se le aplica, está visible.

isVisible: boolean;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Devuelve un PatternType valor que representa el patrón aplicado al relleno o la línea.

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 de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Devuelve el tipo de degradado preestablecido para el relleno.

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 de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Obtiene la textura preestablecida.

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 de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Especifica si el relleno gira con la forma.

rotateWithObject: boolean;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Especifica la alineación (el origen de la cuadrícula de coordenadas) del mosaico de relleno con textura.

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

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Especifica el factor de escala horizontal para el relleno de textura.

textureHorizontalScale: number;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Devuelve el nombre del archivo de textura personalizado para el relleno.

readonly textureName: string;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Especifica el desplazamiento horizontal de la textura desde el origen en puntos.

textureOffsetX: number;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Especifica el desplazamiento vertical de la textura.

textureOffsetY: number;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Especifica si la textura está en mosaico.

textureTile: boolean;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Devuelve el tipo de textura del relleno.

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

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Especifica el factor de escala vertical para el relleno de textura como un valor entre 0,0 y 1,0.

textureVerticalScale: number;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Especifica el grado de transparencia del relleno de una forma como un valor entre 0,0 (opaco) y 1,0 (claro).

transparency: number;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Obtiene el tipo de formato de relleno.

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

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

Devoluciones

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

Devoluciones

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

Devoluciones

Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto API del mismo tipo.

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

Parámetros

Devoluciones

Establece varias propiedades en el objeto al mismo tiempo, basadas en un objeto cargado existente.

set(properties: Word.FillFormat): void;

Parámetros

Devoluciones

Establece el relleno en un degradado de un color.

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

Parámetros

Devoluciones

Comentarios

Conjunto de API: WordApiDesktop 1.3

Establece el relleno en un degradado de un color.

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

Parámetros

Devoluciones

Comentarios

Conjunto de API: WordApiDesktop 1.3

Establece el relleno en un tramo.

setPatterned(pattern: Word.PatternType): void;

Parámetros

Devoluciones

Comentarios

Conjunto de API: WordApiDesktop 1.3

Establece el relleno en un tramo.

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

Devoluciones

Comentarios

Conjunto de API: WordApiDesktop 1.3

Establece el relleno en un degradado preestablecido. El estilo de degradado. La variante de degradado. Puede ser un valor de 1 a 4. El tipo de degradado preestablecido.

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

Parámetros

Devoluciones

Comentarios

Conjunto de API: WordApiDesktop 1.3

Establece el relleno en un degradado preestablecido. El estilo de degradado. La variante de degradado. Puede ser un valor de 1 a 4. El tipo de degradado preestablecido.

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

Devoluciones

Comentarios

Conjunto de API: WordApiDesktop 1.3

Establece el relleno en una textura preestablecida.

setPresetTextured(presetTexture: Word.PresetTexture): void;

Parámetros

Devoluciones

Comentarios

Conjunto de API: WordApiDesktop 1.3

Establece el relleno en una textura preestablecida.

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

Devoluciones

Comentarios

Conjunto de API: WordApiDesktop 1.3

Establece el relleno en un degradado de dos colores.

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

Parámetros

Devoluciones

Comentarios

Conjunto de API: WordApiDesktop 1.3

Establece el relleno en un degradado de dos colores.

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

Parámetros

Devoluciones

Comentarios

Conjunto de API: WordApiDesktop 1.3

Establece el relleno en un color uniforme.

solid(): void;

Devoluciones

Comentarios

Conjunto de API: WordApiDesktop 1.3

Reemplaza el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto API a JSON.stringify(). (JSON.stringify, a su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Word.FillFormat es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como Word.Interfaces.FillFormatData) que contiene copias superficiales de cualquier propiedad secundaria cargada del objeto original.

toJSON(): Word.Interfaces.FillFormatData;

Devoluciones

Realiza un seguimiento del objeto de ajuste automático según cambios adyacentes en el documento. Esta llamada es una abreviatura de context.trackedObjects.add(thisObject). Si usa este objeto entre .sync llamadas y fuera de la ejecución secuencial de un lote ".run" y recibe un error "InvalidObjectPath" al establecer una propiedad o invocar un método en el objeto, debe agregar el objeto a la colección de objetos objeto de seguimiento cuando se creó el objeto por primera vez. Si este objeto forma parte de una colección, también debe realizar un seguimiento de la colección primaria.

track(): Word.FillFormat;

Devoluciones

Libere la memoria asociada a este objeto, si se ha realizado un seguimiento de él anteriormente. Esta llamada es la abreviatura de context.trackedObjects.remove(thisObject). Tener muchos objetos marcados ralentiza la aplicación host, así que debe recordar liberar los objetos que agregue cuando haya terminado con ellos. Deberá llamar context.sync() antes de que la liberación de memoria surta efecto.

untrack(): Word.FillFormat;

Devoluciones