Word.Shading class

Пакет:: word

Представляет Shading объект.

Extends: OfficeExtension.ClientObject

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

// Gets the pattern colors and texture of the sample style.
await Word.run(async (context) => {
  const sampleStyle: Word.Style = context.document.getStyles().getByName("Sample Style");
  const shading: Word.Shading = sampleStyle.shading;
  shading.load("backgroundPatternColor, foregroundPatternColor, texture");
  await context.sync();

  console.log("Background pattern color:", shading.backgroundPatternColor);
  console.log("Foreground pattern color:", shading.foregroundPatternColor);
  console.log("Texture:", shading.texture);
});

Свойства

backgroundPatternColor	Цвет фона объекта. Вы можете указать значение в формате "#RRGGBB" или в названии цвета.
context	Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
foregroundPatternColor	Цвет переднего плана объекта. Вы можете указать значение в формате "#RRGGBB" или в названии цвета.
texture	Определяет текстуру затенения объекта. Дополнительные сведения о применении фона, например текстур, см. в статье Добавление, изменение или удаление цвета фона в Word.

Методы

load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
set(properties, options)	Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.
set(properties)	Одновременно задает несколько свойств объекта на основе существующего загруженного объекта.
toJSON()	Переопределяет метод JavaScript `toJSON()` , чтобы обеспечить более полезные выходные данные при передаче объекта API в `JSON.stringify()`. (`JSON.stringify`, в свою очередь, вызывает `toJSON` метод переданного ему объекта.) В то время как исходный `Word.Shading` объект является объектом API, `toJSON` метод возвращает простой объект JavaScript (типизированный как `Word.Interfaces.ShadingData`), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.
track()	Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех `.sync` вызовах и вне последовательного выполнения пакета ".run" и получаете сообщение об ошибке "InvalidObjectPath" при установке свойства или вызове метода объекта, необходимо добавить объект в коллекцию отслеживаемых объектов при его первом создании. Если этот объект является частью семейства, следует также отслеживать родительскую коллекцию.
untrack()	Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить `context.sync()` , прежде чем освобождение памяти вступит в силу.

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

backgroundPatternColor

Цвет фона объекта. Вы можете указать значение в формате "#RRGGBB" или в названии цвета.

backgroundPatternColor: string;

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

string

Примеры

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

// Sets the background pattern color of the sample style.
await Word.run(async (context) => {
  const sampleStyle: Word.Style = context.document.getStyles().getByName("Sample Style");
  const shading: Word.Shading = sampleStyle.shading;
  shading.backgroundPatternColor = "#D9EAF7";
  await context.sync();

  console.log("Set the Sample Style background pattern color to light blue.");
});

context

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

context: RequestContext;

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

Word.RequestContext

foregroundPatternColor

Цвет переднего плана объекта. Вы можете указать значение в формате "#RRGGBB" или в названии цвета.

foregroundPatternColor: string;

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

string

Примеры

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

// Sets the foreground pattern color of the sample style.
await Word.run(async (context) => {
  const sampleStyle: Word.Style = context.document.getStyles().getByName("Sample Style");
  const shading: Word.Shading = sampleStyle.shading;
  shading.foregroundPatternColor = "#1F4E78";
  await context.sync();

  console.log("Set the Sample Style foreground pattern color to dark blue.");
});

texture

Определяет текстуру затенения объекта. Дополнительные сведения о применении фона, например текстур, см. в статье Добавление, изменение или удаление цвета фона в Word.

texture: Word.ShadingTextureType | "DarkDiagonalDown" | "DarkDiagonalUp" | "DarkGrid" | "DarkHorizontal" | "DarkTrellis" | "DarkVertical" | "LightDiagonalDown" | "LightDiagonalUp" | "LightGrid" | "LightHorizontal" | "LightTrellis" | "LightVertical" | "None" | "Percent10" | "Percent12Pt5" | "Percent15" | "Percent20" | "Percent25" | "Percent30" | "Percent35" | "Percent37Pt5" | "Percent40" | "Percent45" | "Percent5" | "Percent50" | "Percent55" | "Percent60" | "Percent62Pt5" | "Percent65" | "Percent70" | "Percent75" | "Percent80" | "Percent85" | "Percent87Pt5" | "Percent90" | "Percent95" | "Solid";

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

Примеры

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

// Sets the shading texture of the sample style.
await Word.run(async (context) => {
  const sampleStyle: Word.Style = context.document.getStyles().getByName("Sample Style");
  const shading: Word.Shading = sampleStyle.shading;
  const texture: Word.ShadingTextureType = Word.ShadingTextureType.darkTrellis;
  shading.texture = texture;
  await context.sync();

  console.log("Set the Sample Style shading texture to dark trellis.");
});

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

load(options)

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

load(options?: Word.Interfaces.ShadingLoadOptions): Word.Shading;

Параметры

options: Word.Interfaces.ShadingLoadOptions

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

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

Word.Shading

load(propertyNames)

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

Параметры

propertyNames: string | string[]

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

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

Word.Shading

load(propertyNamesAndPaths)

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.Shading;

Параметры

propertyNamesAndPaths: { select?: string; expand?: string; }

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

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

Word.Shading

set(properties, options)

Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.

set(properties: Interfaces.ShadingUpdateData, options?: OfficeExtension.UpdateOptions): void;

Параметры

properties: Word.Interfaces.ShadingUpdateData

Объект JavaScript со свойствами, структурированными изоморфно свойствам объекта, для которого вызывается метод.

options: OfficeExtension.UpdateOptions

Предоставляет возможность подавления ошибок, если объект properties пытается задать какие-либо свойства только для чтения.

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

void

set(properties)

Одновременно задает несколько свойств объекта на основе существующего загруженного объекта.

set(properties: Word.Shading): void;

Параметры

properties: Word.Shading

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

void

toJSON()

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

toJSON(): Word.Interfaces.ShadingData;

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

Word.Interfaces.ShadingData

track()

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

track(): Word.Shading;

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

Word.Shading

untrack()

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

untrack(): Word.Shading;

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

Word.Shading

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

Были ли сведения на этой странице полезными?

Комментарии

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

Примеры

Свойства

Методы

backgroundPatternColor

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

Комментарии

Примеры

context

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

foregroundPatternColor

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

Комментарии

Примеры

texture

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

Комментарии

Примеры

load(options)

Параметры

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

load(propertyNames)

Параметры

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

load(propertyNamesAndPaths)

Параметры

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

set(properties, options)

Параметры

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

set(properties)

Параметры

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

toJSON()

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

track()

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

untrack()

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