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