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 Количество баллов для настройки. |
| 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)
Изменяет горизонтальное смещение тени на количество точек. Increment Количество баллов для настройки.
incrementOffsetX(increment: number): void;Параметры
- increment
-
number
Возвращаемое значение
void
Комментарии
incrementOffsetY(increment)
Изменяет вертикальное смещение тени на указанное количество точек. 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
Предоставляет возможность подавления ошибок, если объект properties пытается задать какие-либо свойства только для чтения.
Возвращаемое значение
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;