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

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

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

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