Word.ShadowFormat class
Представляет форматирование тени для фигуры или текста в Word.
- Extends
Свойства
| blur | Задает уровень размытия для формата тени в виде значения от 0,0 до 100,0. |
| context | Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office. |
| foreground |
|
| is |
Указывает, является ли видимым объект или примененное к нему форматирование. |
| obscured | Указывает, |
| offsetX | Задает горизонтальное смещение (в точках) тени от фигуры. Положительное значение смещает тень справа от фигуры; отрицательное значение смещает его влево. |
| offsetY | Задает вертикальное смещение (в точках) тени от фигуры. Положительное значение смещает тень в верхнюю часть фигуры; отрицательное значение смещает его в нижней части. |
| rotate |
Указывает, следует ли поворачивать тень при повороте фигуры. |
| size | Задает ширину тени. |
| style | Указывает тип форматирования тени, применяемого к фигуре. |
| transparency | Задает степень прозрачности тени в виде значения в диапазоне от 0,0 (непрозрачный) до 1,0 (очистить). |
| type | Задает тип тени фигуры. |
Методы
| increment |
Изменяет горизонтальное смещение тени на количество точек. Приращение — количество точек для изменения. |
| increment |
Изменяет вертикальное смещение тени на указанное количество точек. Приращение — количество точек для изменения. |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| set(properties, options) | Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа. |
| set(properties) | Задает несколько свойств объекта одновременно на основе существующего загруженного объекта. |
| toJSON() | Переопределяет метод JavaScript |
| track() | Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах |
| untrack() | Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить |
Сведения о свойстве
blur
Задает уровень размытия для формата тени в виде значения от 0,0 до 100,0.
blur: number;Значение свойства
number
Комментарии
context
Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
context: RequestContext;Значение свойства
foregroundColor
ColorFormat Возвращает объект , представляющий цвет переднего плана для заливки, линии или тени.
readonly foregroundColor: Word.ColorFormat;Значение свойства
Комментарии
isVisible
Указывает, является ли видимым объект или примененное к нему форматирование.
isVisible: boolean;Значение свойства
boolean
Комментарии
obscured
Указывает, true отображается ли тень фигуры заполненной и скрыта фигурой, даже если фигура не имеет заливки, false если тень не имеет заливки и контур тени виден через фигуру, если фигура не имеет заливки.
obscured: boolean;Значение свойства
boolean
Комментарии
offsetX
Задает горизонтальное смещение (в точках) тени от фигуры. Положительное значение смещает тень справа от фигуры; отрицательное значение смещает его влево.
offsetX: number;Значение свойства
number
Комментарии
offsetY
Задает вертикальное смещение (в точках) тени от фигуры. Положительное значение смещает тень в верхнюю часть фигуры; отрицательное значение смещает его в нижней части.
offsetY: number;Значение свойства
number
Комментарии
rotateWithShape
Указывает, следует ли поворачивать тень при повороте фигуры.
rotateWithShape: boolean;Значение свойства
boolean
Комментарии
size
Задает ширину тени.
size: number;Значение свойства
number
Комментарии
style
Указывает тип форматирования тени, применяемого к фигуре.
style: Word.ShadowStyle | "Mixed" | "OuterShadow" | "InnerShadow";Значение свойства
Word.ShadowStyle | "Mixed" | "OuterShadow" | "InnerShadow"
Комментарии
transparency
Задает степень прозрачности тени в виде значения в диапазоне от 0,0 (непрозрачный) до 1,0 (очистить).
transparency: number;Значение свойства
number
Комментарии
type
Задает тип тени фигуры.
type: Word.ShadowType | "Mixed" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9" | "Type10" | "Type11" | "Type12" | "Type13" | "Type14" | "Type15" | "Type16" | "Type17" | "Type18" | "Type19" | "Type20" | "Type21" | "Type22" | "Type23" | "Type24" | "Type25" | "Type26" | "Type27" | "Type28" | "Type29" | "Type30" | "Type31" | "Type32" | "Type33" | "Type34" | "Type35" | "Type36" | "Type37" | "Type38" | "Type39" | "Type40" | "Type41" | "Type42" | "Type43";Значение свойства
Word.ShadowType | "Mixed" | "Type1" | "Type2" | "Type3" | "Type4" | "Type5" | "Type6" | "Type7" | "Type8" | "Type9" | "Type10" | "Type11" | "Type12" | "Type13" | "Type14" | "Type15" | "Type16" | "Type17" | "Type18" | "Type19" | "Type20" | "Type21" | "Type22" | "Type23" | "Type24" | "Type25" | "Type26" | "Type27" | "Type28" | "Type29" | "Type30" | "Type31" | "Type32" | "Type33" | "Type34" | "Type35" | "Type36" | "Type37" | "Type38" | "Type39" | "Type40" | "Type41" | "Type42" | "Type43"
Комментарии
Сведения о методе
incrementOffsetX(increment)
Изменяет горизонтальное смещение тени на количество точек. Приращение — количество точек для изменения.
incrementOffsetX(increment: number): void;Параметры
- increment
-
number
Возвращаемое значение
void
Комментарии
incrementOffsetY(increment)
Изменяет вертикальное смещение тени на указанное количество точек. Приращение — количество точек для изменения.
incrementOffsetY(increment: number): void;Параметры
- increment
-
number
Возвращаемое значение
void
Комментарии
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Word.Interfaces.ShadowFormatLoadOptions): Word.ShadowFormat;Параметры
Предоставляет параметры свойств объекта для загрузки.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Word.ShadowFormat;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.ShadowFormat;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.
Возвращаемое значение
set(properties, options)
Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties: Interfaces.ShadowFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;Параметры
- properties
- Word.Interfaces.ShadowFormatUpdateData
Объект JavaScript со свойствами, структурированными изоморфно по свойствам объекта, для которого вызывается метод .
- options
- OfficeExtension.UpdateOptions
Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.
Возвращаемое значение
void
set(properties)
Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
set(properties: Word.ShadowFormat): void;Параметры
- properties
- Word.ShadowFormat
Возвращаемое значение
void
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.ShadowFormat объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Word.Interfaces.ShadowFormatData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
toJSON(): Word.Interfaces.ShadowFormatData;Возвращаемое значение
track()
Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах .sync и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта. Если этот объект является частью коллекции, следует также отслеживать родительскую коллекцию.
track(): Word.ShadowFormat;Возвращаемое значение
untrack()
Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить context.sync() до того, как выпуск памяти вступит в силу.
untrack(): Word.ShadowFormat;