Word.FillFormat class

Пакет:

word

Представляет форматирование заливки фигуры или текста.

Extends

OfficeExtension.ClientObject

Комментарии

Набор API: WordApiDesktop 1.3

Используется

• Word. Шрифт: заливка

Свойства

backgroundColor	Возвращает ColorFormat объект, представляющий цвет фона для заливки.
context	Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
foregroundColor	Возвращает ColorFormat объект, который представляет цвет переднего плана для заливки.
gradientAngle	Определяет угол градиентной заливки. Допустимый диапазон значений: от 0 до 359,9.
gradientColorType	Получает тип цвета градиента.
gradientDegree	Возвращает степень темной или светлой одноцветной градиентной заливки. Значение 0 означает, что черный цвет смешивается с цветом переднего плана фигуры для формирования градиента. Значение 1 означает, что к этому примешивается белый. Значения от 0 до 1 означают, что к этому добавляется более темный или более светлый оттенок цвета переднего плана.
gradientStyle	Возвращает градиентный стиль заливки.
gradientVariant	Возвращает вариант градиента для заливки как целое значение от 1 до 4 для большинства градиентных заливок.
isVisible	Указывает, виден ли объект или примененное к нему форматирование.
pattern	Возвращает PatternType значение, представляющее шаблон, примененный к заливке или линии.
presetGradientType	Возвращает готовый тип градиента для заливки.
presetTexture	Получает готовую текстуру.
rotateWithObject	Определяет, будет ли заливка поворачиваться вместе с фигурой.
textureAlignment	Задает выравнивание (начало координатной сетки) для замощения текстурной заливки.
textureHorizontalScale	Определяет коэффициент масштабирования по горизонтали для заливки текстуры.
textureName	Возвращает имя файла пользовательской текстуры для заливки.
textureOffsetX	Задает горизонтальное смещение текстуры относительно начала координат в точках.
textureOffsetY	Задает смещение текстуры по вертикали.
textureTile	Указывает, является ли текстура мозаичной.
textureType	Возвращает тип текстуры для заливки.
textureVerticalScale	Указывает коэффициент масштабирования по вертикали для заливки текстуры в качестве значения от 0,0 до 1,0.
transparency	Определяет степень прозрачности заливки для фигуры в диапазоне от 0,0 (непрозрачная) до 1,0 (чистая).
type	Получает тип формата заливки.

Методы

load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
set(properties, options)	Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.
set(properties)	Одновременно задает несколько свойств объекта на основе существующего загруженного объекта.
setOneColorGradient(style, variant, degree)	Одноцветный градиент для заливки.
setOneColorGradient(style, variant, degree)	Одноцветный градиент для заливки.
setPatterned(pattern)	Задает образец заливки.
setPatterned(pattern)	Задает образец заливки.
setPresetGradient(style, variant, presetGradientType)	Задает заданный градиент для заливки. Градиентный стиль. Градиентный вариант. Может принимать значения от 1 до 4. Тип готового градиента.
setPresetGradient(style, variant, presetGradientType)	Задает заданный градиент для заливки. Градиентный стиль. Градиентный вариант. Может принимать значения от 1 до 4. Тип готового градиента.
setPresetTextured(presetTexture)	Устанавливает для заливки заготовку текстуры.
setPresetTextured(presetTexture)	Устанавливает для заливки заготовку текстуры.
setTwoColorGradient(style, variant)	Двухцветный градиент для заливки.
setTwoColorGradient(style, variant)	Двухцветный градиент для заливки.
solid()	Устанавливает заливку однородного цвета.
toJSON()	Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.FillFormat объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Word.Interfaces.FillFormatData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.
track()	Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех .sync вызовах и вне последовательного выполнения пакета ".run" и получаете сообщение об ошибке "InvalidObjectPath" при установке свойства или вызове метода объекта, необходимо добавить объект в коллекцию отслеживаемых объектов при его первом создании. Если этот объект является частью семейства, следует также отслеживать родительскую коллекцию.
untrack()	Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить context.sync() , прежде чем освобождение памяти вступит в силу.

Сведения о свойстве

backgroundColor

Возвращает ColorFormat объект, представляющий цвет фона для заливки.

readonly backgroundColor: Word.ColorFormat;

Значение свойства

Word.ColorFormat

Комментарии

Набор API: WordApiDesktop 1.3

context

Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.

context: RequestContext;

Значение свойства

Word.RequestContext

foregroundColor

Возвращает ColorFormat объект, который представляет цвет переднего плана для заливки.

readonly foregroundColor: Word.ColorFormat;

Значение свойства

Word.ColorFormat

Комментарии

Набор API: WordApiDesktop 1.3

gradientAngle

Определяет угол градиентной заливки. Допустимый диапазон значений: от 0 до 359,9.

gradientAngle: number;

Значение свойства

number

Комментарии

Набор API: WordApiDesktop 1.3

gradientColorType

Получает тип цвета градиента.

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

Значение свойства

Word.GradientColorType | "Mixed" | "OneColor" | "TwoColors" | "PresetColors" | "MultiColor"

Комментарии

Набор API: WordApiDesktop 1.3

gradientDegree

Возвращает степень темной или светлой одноцветной градиентной заливки. Значение 0 означает, что черный цвет смешивается с цветом переднего плана фигуры для формирования градиента. Значение 1 означает, что к этому примешивается белый. Значения от 0 до 1 означают, что к этому добавляется более темный или более светлый оттенок цвета переднего плана.

readonly gradientDegree: number;

Значение свойства

number

Комментарии

Набор API: WordApiDesktop 1.3

gradientStyle

Возвращает градиентный стиль заливки.

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

Значение свойства

Word.GradientStyle | "Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter"

Комментарии

Набор API: WordApiDesktop 1.3

gradientVariant

Возвращает вариант градиента для заливки как целое значение от 1 до 4 для большинства градиентных заливок.

readonly gradientVariant: number;

Значение свойства

number

Комментарии

Набор API: WordApiDesktop 1.3

isVisible

Указывает, виден ли объект или примененное к нему форматирование.

isVisible: boolean;

Значение свойства

boolean

Комментарии

Набор API: WordApiDesktop 1.3

pattern

Возвращает PatternType значение, представляющее шаблон, примененный к заливке или линии.

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

Значение свойства

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"

Комментарии

Набор API: WordApiDesktop 1.3

presetGradientType

Возвращает готовый тип градиента для заливки.

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

Значение свойства

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"

Комментарии

Набор API: WordApiDesktop 1.3

presetTexture

Получает готовую текстуру.

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

Значение свойства

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"

Комментарии

Набор API: WordApiDesktop 1.3

rotateWithObject

Определяет, будет ли заливка поворачиваться вместе с фигурой.

rotateWithObject: boolean;

Значение свойства

boolean

Комментарии

Набор API: WordApiDesktop 1.3

textureAlignment

Задает выравнивание (начало координатной сетки) для замощения текстурной заливки.

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

Значение свойства

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

Комментарии

Набор API: WordApiDesktop 1.3

textureHorizontalScale

Определяет коэффициент масштабирования по горизонтали для заливки текстуры.

textureHorizontalScale: number;

Значение свойства

number

Комментарии

Набор API: WordApiDesktop 1.3

textureName

Возвращает имя файла пользовательской текстуры для заливки.

readonly textureName: string;

Значение свойства

string

Комментарии

Набор API: WordApiDesktop 1.3

textureOffsetX

Задает горизонтальное смещение текстуры относительно начала координат в точках.

textureOffsetX: number;

Значение свойства

number

Комментарии

Набор API: WordApiDesktop 1.3

textureOffsetY

Задает смещение текстуры по вертикали.

textureOffsetY: number;

Значение свойства

number

Комментарии

Набор API: WordApiDesktop 1.3

textureTile

Указывает, является ли текстура мозаичной.

textureTile: boolean;

Значение свойства

boolean

Комментарии

Набор API: WordApiDesktop 1.3

textureType

Возвращает тип текстуры для заливки.

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

Значение свойства

Word.TextureType | "Mixed" | "Preset" | "UserDefined"

Комментарии

Набор API: WordApiDesktop 1.3

textureVerticalScale

Указывает коэффициент масштабирования по вертикали для заливки текстуры в качестве значения от 0,0 до 1,0.

textureVerticalScale: number;

Значение свойства

number

Комментарии

Набор API: WordApiDesktop 1.3

transparency

Определяет степень прозрачности заливки для фигуры в диапазоне от 0,0 (непрозрачная) до 1,0 (чистая).

transparency: number;

Значение свойства

number

Комментарии

Набор API: WordApiDesktop 1.3

type

Получает тип формата заливки.

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

Значение свойства

Word.FillType | "Mixed" | "Solid" | "Patterned" | "Gradient" | "Textured" | "Background" | "Picture"

Комментарии

Набор API: WordApiDesktop 1.3

Сведения о методе

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

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

Параметры

options

Word.Interfaces.FillFormatLoadOptions

Предоставляет параметры для загружаемых свойств объекта.

Возвращаемое значение

Word.FillFormat

load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

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

Параметры

propertyNames

string | string[]

Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.

Возвращаемое значение

Word.FillFormat

load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

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

Параметры

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.

Возвращаемое значение

Word.FillFormat

set(properties, options)

Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.

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

Параметры

properties

Word.Interfaces.FillFormatUpdateData

Объект JavaScript со свойствами, структурированными изоморфно свойствам объекта, для которого вызывается метод.

options

OfficeExtension.UpdateOptions

Предоставляет возможность подавления ошибок, если объект properties пытается задать какие-либо свойства только для чтения.

Возвращаемое значение

void

set(properties)

Одновременно задает несколько свойств объекта на основе существующего загруженного объекта.

set(properties: Word.FillFormat): void;

Параметры

properties

Word.FillFormat

Возвращаемое значение

void

setOneColorGradient(style, variant, degree)

Одноцветный градиент для заливки.

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

Параметры

style

Word.GradientStyle

Градиентный стиль.

variant

number

Градиентный вариант. Может принимать значения от 1 до 4.

degree

number

Степень градиента. Может принимать значения от 0.0 (темный) до 1.0 (светлый).

Возвращаемое значение

void

Комментарии

Набор API: WordApiDesktop 1.3

setOneColorGradient(style, variant, degree)

Одноцветный градиент для заливки.

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

Параметры

style

"Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter"

Градиентный стиль.

variant

number

Градиентный вариант. Может принимать значения от 1 до 4.

degree

number

Степень градиента. Может принимать значения от 0.0 (темный) до 1.0 (светлый).

Возвращаемое значение

void

Комментарии

Набор API: WordApiDesktop 1.3

setPatterned(pattern)

Задает образец заливки.

setPatterned(pattern: Word.PatternType): void;

Параметры

pattern

Word.PatternType

Возвращаемое значение

void

Комментарии

Набор API: WordApiDesktop 1.3

setPatterned(pattern)

Задает образец заливки.

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;

Параметры

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

Комментарии

Набор API: WordApiDesktop 1.3

setPresetGradient(style, variant, presetGradientType)

Задает заданный градиент для заливки. Градиентный стиль. Градиентный вариант. Может принимать значения от 1 до 4. Тип готового градиента.

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

Параметры

style

Word.GradientStyle

variant

number

presetGradientType

Word.PresetGradientType

Возвращаемое значение

void

Комментарии

Набор API: WordApiDesktop 1.3

setPresetGradient(style, variant, presetGradientType)

Задает заданный градиент для заливки. Градиентный стиль. Градиентный вариант. Может принимать значения от 1 до 4. Тип готового градиента.

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;

Параметры

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

Комментарии

Набор API: WordApiDesktop 1.3

setPresetTextured(presetTexture)

Устанавливает для заливки заготовку текстуры.

setPresetTextured(presetTexture: Word.PresetTexture): void;

Параметры

presetTexture

Word.PresetTexture

Возвращаемое значение

void

Комментарии

Набор API: WordApiDesktop 1.3

setPresetTextured(presetTexture)

Устанавливает для заливки заготовку текстуры.

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;

Параметры

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

Комментарии

Набор API: WordApiDesktop 1.3

setTwoColorGradient(style, variant)

Двухцветный градиент для заливки.

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

Параметры

style

Word.GradientStyle

variant

number

Возвращаемое значение

void

Комментарии

Набор API: WordApiDesktop 1.3

setTwoColorGradient(style, variant)

Двухцветный градиент для заливки.

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

Параметры

style

"Mixed" | "Horizontal" | "Vertical" | "DiagonalUp" | "DiagonalDown" | "FromCorner" | "FromTitle" | "FromCenter"

variant

number

Возвращаемое значение

void

Комментарии

Набор API: WordApiDesktop 1.3

solid()

Устанавливает заливку однородного цвета.

solid(): void;

Возвращаемое значение

void

Комментарии

Набор API: WordApiDesktop 1.3

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.FillFormat объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Word.Interfaces.FillFormatData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.

toJSON(): Word.Interfaces.FillFormatData;

Возвращаемое значение

Word.Interfaces.FillFormatData

track()

Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех .sync вызовах и вне последовательного выполнения пакета ".run" и получаете сообщение об ошибке "InvalidObjectPath" при установке свойства или вызове метода объекта, необходимо добавить объект в коллекцию отслеживаемых объектов при его первом создании. Если этот объект является частью семейства, следует также отслеживать родительскую коллекцию.

track(): Word.FillFormat;

Возвращаемое значение

Word.FillFormat

untrack()

Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить context.sync() , прежде чем освобождение памяти вступит в силу.

untrack(): Word.FillFormat;

Возвращаемое значение

Word.FillFormat