Word.ShapeTextWrap class
Представляет все свойства для упаковки текста вокруг фигуры.
- Extends
Комментарии
[ Набор API: WordApiDesktop 1.2 ]
Свойства
| bottom |
Указывает расстояние (в точках) между текстом документа и нижним краем области, свободной от текста, вокруг указанной фигуры. |
| context | Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office. |
| left |
Указывает расстояние (в точках) между текстом документа и левым краем области, свободной от текста, вокруг указанной фигуры. |
| right |
Указывает расстояние (в точках) между текстом документа и правым краем области, свободной от текста, вокруг указанной фигуры. |
| side | Указывает, следует ли переносить текст документа с обеих сторон указанной фигуры, только с левой или правой стороны или на стороне фигуры, наиболее удаленной от поля страницы. |
| top |
Указывает расстояние (в точках) между текстом документа и верхним краем области, свободной от текста, вокруг указанной фигуры. |
| type | Указывает тип обтекателя текста вокруг фигуры. Дополнительные сведения см. в этой |
Методы
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| set(properties, options) | Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа. |
| set(properties) | Задает несколько свойств объекта одновременно на основе существующего загруженного объекта. |
| toJSON() | Переопределяет метод JavaScript |
| track() | Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах |
| untrack() | Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить |
Сведения о свойстве
bottomDistance
Указывает расстояние (в точках) между текстом документа и нижним краем области, свободной от текста, вокруг указанной фигуры.
bottomDistance: number;Значение свойства
number
Комментарии
context
Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
context: RequestContext;Значение свойства
leftDistance
Указывает расстояние (в точках) между текстом документа и левым краем области, свободной от текста, вокруг указанной фигуры.
leftDistance: number;Значение свойства
number
Комментарии
rightDistance
Указывает расстояние (в точках) между текстом документа и правым краем области, свободной от текста, вокруг указанной фигуры.
rightDistance: number;Значение свойства
number
Комментарии
side
Указывает, следует ли переносить текст документа с обеих сторон указанной фигуры, только с левой или правой стороны или на стороне фигуры, наиболее удаленной от поля страницы.
side: Word.ShapeTextWrapSide | "None" | "Both" | "Left" | "Right" | "Largest";Значение свойства
Word.ShapeTextWrapSide | "None" | "Both" | "Left" | "Right" | "Largest"
Комментарии
topDistance
Указывает расстояние (в точках) между текстом документа и верхним краем области, свободной от текста, вокруг указанной фигуры.
topDistance: number;Значение свойства
number
Комментарии
type
Указывает тип обтекателя текста вокруг фигуры. Дополнительные сведения см. в этой Word.ShapeTextWrapType статье.
type: Word.ShapeTextWrapType | "Inline" | "Square" | "Tight" | "Through" | "TopBottom" | "Behind" | "Front";Значение свойства
Word.ShapeTextWrapType | "Inline" | "Square" | "Tight" | "Through" | "TopBottom" | "Behind" | "Front"
Комментарии
Сведения о методе
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: Word.Interfaces.ShapeTextWrapLoadOptions): Word.ShapeTextWrap;Параметры
Предоставляет параметры свойств объекта для загрузки.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Word.ShapeTextWrap;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.ShapeTextWrap;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.
Возвращаемое значение
set(properties, options)
Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties: Interfaces.ShapeTextWrapUpdateData, options?: OfficeExtension.UpdateOptions): void;Параметры
- properties
- Word.Interfaces.ShapeTextWrapUpdateData
Объект JavaScript со свойствами, структурированными изоморфно по свойствам объекта, для которого вызывается метод .
- options
- OfficeExtension.UpdateOptions
Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.
Возвращаемое значение
void
set(properties)
Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
set(properties: Word.ShapeTextWrap): void;Параметры
- properties
- Word.ShapeTextWrap
Возвращаемое значение
void
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.ShapeTextWrap объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как Word.Interfaces.ShapeTextWrapData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
toJSON(): Word.Interfaces.ShapeTextWrapData;Возвращаемое значение
track()
Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением для context.trackedObjects.add(thisObject). Если вы используете этот объект в вызовах .sync и вне последовательного выполнения пакета .run и получаете ошибку InvalidObjectPath при задании свойства или вызове метода для объекта, необходимо добавить объект в отслеживаемую коллекцию объектов при первом создании объекта. Если этот объект является частью коллекции, следует также отслеживать родительскую коллекцию.
track(): Word.ShapeTextWrap;Возвращаемое значение
untrack()
Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращенным для context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вызов потребуется выполнить context.sync() до того, как выпуск памяти вступит в силу.
untrack(): Word.ShapeTextWrap;Возвращаемое значение
Office Add-ins