Word.BorderCollection class

Представляет коллекцию стилей границ.

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/28-formatting/manage-styles.yaml

// Gets the outside border properties of the sample style.
await Word.run(async (context) => {
  const sampleStyle: Word.Style = context.document.getStyles().getByName("Sample Style");
  const borders: Word.BorderCollection = sampleStyle.borders;
  borders.load("outsideBorderColor, outsideBorderType, outsideBorderWidth");
  await context.sync();

  console.log("Outside border color:", borders.outsideBorderColor);
  console.log("Outside border type:", borders.outsideBorderType);
  console.log("Outside border width:", borders.outsideBorderWidth);
});

Свойства

context	Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
insideBorderColor	Определяет 24-битовый цвет внутренних границ. Цвет указывается в формате "#RRGGBB" или с помощью имени цвета.
insideBorderType	Определяет тип границы внутренних границ.
insideBorderWidth	Ширина внутренних границ.
items	Получает загруженные дочерние элементы в этой коллекции.
outsideBorderColor	Определяет 24-битовый цвет внешних границ. Цвет указывается в формате "#RRGGBB" или с помощью имени цвета.
outsideBorderType	Задает тип границы внешних границ.
outsideBorderWidth	Определяет ширину внешних границ.

Методы

getByLocation(borderLocation)	Получает границу с указанным расположением.
getFirst()	Получает первую границу в коллекции. Если эта коллекция пуста, возникает `ItemNotFound` ошибка.
getFirstOrNullObject()	Получает первую границу в коллекции. Если эта коллекция пуста, то этот метод вернет объект со свойством `isNullObject` , установленным в `true`. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.
getItem(index)	Получает `Border` объект по его индексу в коллекции.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
toJSON()	Переопределяет метод JavaScript `toJSON()` , чтобы обеспечить более полезные выходные данные при передаче объекта API в `JSON.stringify()`. (`JSON.stringify`, в свою очередь, вызывает `toJSON` метод переданного ему объекта.) В то время как исходный `Word.BorderCollection` объект является объектом API, `toJSON` метод возвращает простой объект JavaScript (типизированный как `Word.Interfaces.BorderCollectionData`), который содержит массив «items» с неглубокими копиями любых загруженных свойств из элементов коллекции.
track()	Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех `.sync` вызовах и вне последовательного выполнения пакета ".run" и получаете сообщение об ошибке "InvalidObjectPath" при установке свойства или вызове метода объекта, необходимо добавить объект в коллекцию отслеживаемых объектов при его первом создании. Если этот объект является частью семейства, следует также отслеживать родительскую коллекцию.
untrack()	Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить `context.sync()` , прежде чем освобождение памяти вступит в силу.

context

Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.

context: RequestContext;

Значение свойства

Word.RequestContext

insideBorderColor

Определяет 24-битовый цвет внутренних границ. Цвет указывается в формате "#RRGGBB" или с помощью имени цвета.

insideBorderColor: string;

Значение свойства

string

insideBorderType

Определяет тип границы внутренних границ.

insideBorderType: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave";

Значение свойства

insideBorderWidth

Ширина внутренних границ.

insideBorderWidth: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed";

Значение свойства

Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed"

items

Получает загруженные дочерние элементы в этой коллекции.

readonly items: Word.Border[];

Значение свойства

Word.Border[]

outsideBorderColor

Определяет 24-битовый цвет внешних границ. Цвет указывается в формате "#RRGGBB" или с помощью имени цвета.

outsideBorderColor: string;

Значение свойства

string

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/28-formatting/manage-styles.yaml

// Sets the outside border color of the sample style.
await Word.run(async (context) => {
  const sampleStyle: Word.Style = context.document.getStyles().getByName("Sample Style");
  const borders: Word.BorderCollection = sampleStyle.borders;
  borders.outsideBorderColor = "#4472C4";
  await context.sync();

  console.log("Set the Sample Style outside border color to blue.");
});

outsideBorderType

Задает тип границы внешних границ.

outsideBorderType: Word.BorderType | "Mixed" | "None" | "Single" | "Double" | "Dotted" | "Dashed" | "DotDashed" | "Dot2Dashed" | "Triple" | "ThinThickSmall" | "ThickThinSmall" | "ThinThickThinSmall" | "ThinThickMed" | "ThickThinMed" | "ThinThickThinMed" | "ThinThickLarge" | "ThickThinLarge" | "ThinThickThinLarge" | "Wave" | "DoubleWave" | "DashedSmall" | "DashDotStroked" | "ThreeDEmboss" | "ThreeDEngrave";

Значение свойства

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/28-formatting/manage-styles.yaml

// Sets the outside border type of the sample style.
await Word.run(async (context) => {
  const sampleStyle: Word.Style = context.document.getStyles().getByName("Sample Style");
  const borders: Word.BorderCollection = sampleStyle.borders;
  borders.outsideBorderType = Word.BorderType.dashed;
  await context.sync();

  console.log("Set the Sample Style outside border type to dashed.");
});

outsideBorderWidth

Определяет ширину внешних границ.

outsideBorderWidth: Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed";

Значение свойства

Word.BorderWidth | "None" | "Pt025" | "Pt050" | "Pt075" | "Pt100" | "Pt150" | "Pt225" | "Pt300" | "Pt450" | "Pt600" | "Mixed"

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/28-formatting/manage-styles.yaml

// Sets the outside border width of the sample style.
await Word.run(async (context) => {
  const sampleStyle: Word.Style = context.document.getStyles().getByName("Sample Style");
  const borders: Word.BorderCollection = sampleStyle.borders;
  const borderWidth: Word.BorderWidth = Word.BorderWidth.pt225;
  borders.outsideBorderWidth = borderWidth;
  await context.sync();

  console.log("Set the Sample Style outside border width to 2.25 points.");
});

getByLocation(borderLocation)

Получает границу с указанным расположением.

getByLocation(borderLocation: Word.BorderLocation.top | Word.BorderLocation.left | Word.BorderLocation.bottom | Word.BorderLocation.right | Word.BorderLocation.insideHorizontal | Word.BorderLocation.insideVertical | "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical"): Word.Border;

Параметры

borderLocation: top | left | bottom | right | insideHorizontal | insideVertical | "Top" | "Left" | "Bottom" | "Right" | "InsideHorizontal" | "InsideVertical"

Возвращаемое значение

Word.Border

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/28-formatting/border-properties.yaml

// Loads all scalar properties and returns them as a plain JavaScript object.
await Word.run(async (context) => {
  const style: Word.Style = context.document.getStyles().getByName("Bordered Text");
  const borders: Word.BorderCollection = style.borders;
  const border: Word.Border = borders.getByLocation(Word.BorderLocation.bottom);
  border.load("color, location, type, visible, width");
  await context.sync();

  console.log("Border properties:", border.toJSON());
});

getFirst()

Получает первую границу в коллекции. Если эта коллекция пуста, возникает ItemNotFound ошибка.

getFirst(): Word.Border;

Возвращаемое значение

Word.Border

getFirstOrNullObject()

Получает первую границу в коллекции. Если эта коллекция пуста, то этот метод вернет объект со свойством isNullObject , установленным в true. Дополнительные сведения см. в разделе Методы и свойства *OrNullObject.

getFirstOrNullObject(): Word.Border;

Возвращаемое значение

Word.Border

getItem(index)

Получает Border объект по его индексу в коллекции.

getItem(index: number): Word.Border;

Параметры

index: number

Расположение Border объекта.

Возвращаемое значение

Word.Border

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(options?: Word.Interfaces.BorderCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.BorderCollection;

Параметры

options: Word.Interfaces.BorderCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions

Предоставляет параметры для загружаемых свойств объекта.

Возвращаемое значение

Word.BorderCollection

load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNames?: string | string[]): Word.BorderCollection;

Параметры

propertyNames: string | string[]

Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.

Возвращаемое значение

Word.BorderCollection

load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.BorderCollection;

Параметры

propertyNamesAndPaths: OfficeExtension.LoadOption

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.

Возвращаемое значение

Word.BorderCollection

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.BorderCollection объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Word.Interfaces.BorderCollectionData), который содержит массив «items» с неглубокими копиями любых загруженных свойств из элементов коллекции.

toJSON(): Word.Interfaces.BorderCollectionData;

Возвращаемое значение

Word.Interfaces.BorderCollectionData

track()

Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех .sync вызовах и вне последовательного выполнения пакета ".run" и получаете сообщение об ошибке "InvalidObjectPath" при установке свойства или вызове метода объекта, необходимо добавить объект в коллекцию отслеживаемых объектов при его первом создании. Если этот объект является частью семейства, следует также отслеживать родительскую коллекцию.

track(): Word.BorderCollection;

Возвращаемое значение

Word.BorderCollection

untrack()

Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить context.sync() , прежде чем освобождение памяти вступит в силу.

untrack(): Word.BorderCollection;

Возвращаемое значение

Word.BorderCollection

Комментарии

Используется

Примеры

Свойства

Методы

Сведения о свойстве

context

Значение свойства

insideBorderColor

Значение свойства

Комментарии

insideBorderType

Значение свойства

Комментарии

insideBorderWidth

Значение свойства

Комментарии

items

Значение свойства

outsideBorderColor

Значение свойства

Комментарии

Примеры

outsideBorderType

Значение свойства

Комментарии

Примеры

outsideBorderWidth

Значение свойства

Комментарии

Примеры

Сведения о методе

getByLocation(borderLocation)

Параметры

Возвращаемое значение

Комментарии

Примеры

getFirst()

Возвращаемое значение

Комментарии

getFirstOrNullObject()

Возвращаемое значение

Комментарии

getItem(index)

Параметры

Возвращаемое значение

Комментарии

load(options)

Параметры

Возвращаемое значение

load(propertyNames)

Параметры

Возвращаемое значение

load(propertyNamesAndPaths)

Параметры

Возвращаемое значение

toJSON()

Возвращаемое значение

track()

Возвращаемое значение

untrack()

Возвращаемое значение

Обратная связь