Word.ShapeTextWrap class
Представляет все свойства для обтекания текстом в Word. Фигура.
- Extends
Комментарии
Используется
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/45-shapes/manage-shapes-text-boxes.yaml
await Word.run(async (context) => {
// Gets text wrap properties of the first text box in the main document.
const shape: Word.Shape = context.document.body.shapes.getByTypes([Word.ShapeType.textBox]).getFirstOrNullObject();
shape.load("textWrap");
await context.sync();
if (shape.isNullObject) {
console.log("No shapes with text boxes found in the main document.");
return;
}
console.log("Text wrap properties of first text box:", shape.textWrap);
});
Свойства
| 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"
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/45-shapes/manage-shapes-text-boxes.yaml
await Word.run(async (context) => {
// Sets text wrap properties of the first text box.
const firstShapeWithTextBox: Word.Shape = context.document.body.shapes
.getByTypes([Word.ShapeType.textBox])
.getFirstOrNullObject();
firstShapeWithTextBox.load("textWrap");
await context.sync();
if (firstShapeWithTextBox.isNullObject) {
console.log("No shapes with text boxes found in main document.");
return;
}
const textWrap: Word.ShapeTextWrap = firstShapeWithTextBox.textWrap;
textWrap.type = Word.ShapeTextWrapType.square;
textWrap.side = Word.ShapeTextWrapSide.both;
console.log("The first text box's text wrap properties were updated:", textWrap);
});
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"
Комментарии
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/45-shapes/manage-shapes-text-boxes.yaml
await Word.run(async (context) => {
// Sets text wrap properties of the first text box.
const firstShapeWithTextBox: Word.Shape = context.document.body.shapes
.getByTypes([Word.ShapeType.textBox])
.getFirstOrNullObject();
firstShapeWithTextBox.load("textWrap");
await context.sync();
if (firstShapeWithTextBox.isNullObject) {
console.log("No shapes with text boxes found in main document.");
return;
}
const textWrap: Word.ShapeTextWrap = firstShapeWithTextBox.textWrap;
textWrap.type = Word.ShapeTextWrapType.square;
textWrap.side = Word.ShapeTextWrapSide.both;
console.log("The first text box's text wrap properties were updated:", textWrap);
});
Сведения о методе
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
Предоставляет возможность подавления ошибок, если объект properties пытается задать какие-либо свойства только для чтения.
Возвращаемое значение
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;