Word.ShapeFill class
Представляет форматирование заливки объекта фигуры.
- Extends
Комментарии
[ Набор API: WordApiDesktop 1.2 ]
Свойства
| background |
Задает цвет фона заливки фигуры. Можно указать значение в формате "#RRGGBB" или в имени цвета. |
| context | Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office. |
| foreground |
Задает цвет переднего плана заливки фигуры. Можно указать значение в формате "#RRGGBB" или в имени цвета. |
| transparency | Задает процент прозрачности заливки в виде значения от 0,0 (непрозрачный) до 1,0 (очистить). Возвращает значение |
| type | Возвращает тип заливки фигуры. Дополнительные сведения см. в этой |
Методы
| clear() | Очищает форматирование заливки этой фигуры и задает для нее значение |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| set(properties, options) | Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа. |
| set(properties) | Задает несколько свойств объекта одновременно на основе существующего загруженного объекта. |
| set |
Задает заливку одним цветом для фигуры. При этом тип заполнения изменится на |
| toJSON() | Переопределяет метод JavaScript |
| track() | Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах |
| untrack() | Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить |
Сведения о свойстве
backgroundColor
Задает цвет фона заливки фигуры. Можно указать значение в формате "#RRGGBB" или в имени цвета.
backgroundColor: string;Значение свойства
string
Комментарии
context
Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
context: RequestContext;Значение свойства
foregroundColor
Задает цвет переднего плана заливки фигуры. Можно указать значение в формате "#RRGGBB" или в имени цвета.
foregroundColor: string;Значение свойства
string
Комментарии
transparency
Задает процент прозрачности заливки в виде значения от 0,0 (непрозрачный) до 1,0 (очистить). Возвращает значение null , если тип фигуры не поддерживает прозрачность или заливка фигуры имеет несогласованную прозрачность, например с градиентным типом заливки.
transparency: number;Значение свойства
number
Комментарии
type
Возвращает тип заливки фигуры. Дополнительные сведения см. в этой Word.ShapeFillType статье.
readonly type: Word.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "Picture" | "Texture" | "Mixed";Значение свойства
Word.ShapeFillType | "NoFill" | "Solid" | "Gradient" | "Pattern" | "Picture" | "Texture" | "Mixed"
Комментарии
Сведения о методе
clear()
Очищает форматирование заливки этой фигуры и задает для нее значение Word.ShapeFillType.NoFill;
clear(): void;Возвращаемое значение
void
Комментарии
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Word.Interfaces.ShapeFillLoadOptions): Word.ShapeFill;Параметры
Предоставляет параметры свойств объекта для загрузки.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Word.ShapeFill;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.ShapeFill;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.
Возвращаемое значение
set(properties, options)
Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties: Interfaces.ShapeFillUpdateData, options?: OfficeExtension.UpdateOptions): void;Параметры
- properties
- Word.Interfaces.ShapeFillUpdateData
Объект JavaScript со свойствами, структурированными изоморфно по свойствам объекта, для которого вызывается метод .
- options
- OfficeExtension.UpdateOptions
Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.
Возвращаемое значение
void
set(properties)
Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
set(properties: Word.ShapeFill): void;Параметры
- properties
- Word.ShapeFill
Возвращаемое значение
void
setSolidColor(color)
Задает заливку одним цветом для фигуры. При этом тип заполнения изменится на Word.ShapeFillType.Solid.
setSolidColor(color: string): void;Параметры
- color
-
string
Строка, представляющая цвет переднего плана заливки. Можно указать значение в формате "#RRGGBB" или в имени цвета.
Возвращаемое значение
void
Комментарии
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.ShapeFill объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Word.Interfaces.ShapeFillData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
toJSON(): Word.Interfaces.ShapeFillData;Возвращаемое значение
track()
Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах .sync и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта. Если этот объект является частью коллекции, следует также отслеживать родительскую коллекцию.
track(): Word.ShapeFill;Возвращаемое значение
untrack()
Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить context.sync() до того, как выпуск памяти вступит в силу.
untrack(): Word.ShapeFill;Возвращаемое значение
Office Add-ins