Word.ThreeDimensionalFormat class

Пакет:

word

Представляет трехмерное форматирование фигуры.

Extends

OfficeExtension.ClientObject

Комментарии

Набор API: WordApiDesktop 1.3

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

• Word. Шрифт: threeDimensionalFormat

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/apply-bevel-to-text.yaml

if (!Office.context.requirements.isSetSupported("WordApiDesktop", "1.3")) {
  console.error("This sample requires WordApiDesktop 1.3 or later.");
  return;
}

await Word.run(async (context) => {
  const paragraph: Word.Paragraph = context.document.body.insertParagraph(
    "Beveled text",
    Word.InsertLocation.start,
  );
  paragraph.font.size = 48;
  paragraph.font.bold = true;

  const threeDimensionalFormat: Word.ThreeDimensionalFormat = paragraph.font.threeDimensionalFormat;
  threeDimensionalFormat.isVisible = true;
  threeDimensionalFormat.bevelTopType = Word.BevelType.circle;
  threeDimensionalFormat.bevelTopDepth = 6;
  threeDimensionalFormat.bevelTopInset = 6;
  threeDimensionalFormat.load("bevelTopType,bevelTopDepth,bevelTopInset");

  await context.sync();

  console.log("Applied bevel formatting:", {
    type: threeDimensionalFormat.bevelTopType,
    depth: threeDimensionalFormat.bevelTopDepth,
    inset: threeDimensionalFormat.bevelTopInset,
  });
});

Свойства

bevelBottomDepth	Задает глубину нижнего скоса.
bevelBottomInset	Задает размер отступа для нижней скосы.
bevelBottomType	Задает BevelType значение, представляющее тип скоса для нижнего скоса.
bevelTopDepth	Задает глубину верхнего скоса.
bevelTopInset	Задает размер отступа для верхнего скоса.
bevelTopType	Задает BevelType значение, представляющее тип скоса для верхнего скоса.
context	Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
contourColor	Возвращает объект, ColorFormat который представляет цвет контура фигуры.
contourWidth	Определяет ширину контура фигуры.
depth	Определяет глубину выдавливания фигуры.
extrusionColor	Возвращает объект, ColorFormat представляющий цвет выдавливания фигуры.
extrusionColorType	Указывает, зависит ли цвет вытягивания от заливки вытянутой фигуры (лицевой поверхности выдавливания) и изменяется ли автоматически при изменении заливки фигуры или же цвет вытягивания не зависит от заливки фигуры.
fieldOfView	Определяет величину перспективы для фигуры.
isPerspective	Определяет true , выглядит ли вытягивание в перспективе, то есть если стенки вытягивания сужаются к точке схода, false если вытягивание является параллельной или ортографической проекцией, то есть если стены не сужаются к точке схода.
isVisible	Указывает, виден ли указанный объект или примененное к нему форматирование.
lightAngle	Определяет угол освещения.
presetCamera	Возвращает PresetCamera значение, представляющее предустановки камеры.
presetExtrusionDirection	Возвращает направление траектории вытягивания от вытянутой фигуры (лицевая поверхность выдавливания).
presetLighting	Задает LightRigType значение, представляющее предустановку освещения.
presetLightingDirection	Определяет положение источника света относительно выдавливания.
presetLightingSoftness	Определяет интенсивность экструзионного освещения.
presetMaterial	Определяет материал поверхности выдавливания.
presetThreeDimensionalFormat	Возвращает предустановленный формат экструзии.
projectText	Определяет, будет ли текст на фигуре поворачиваться вместе с фигурой. true Поворот текста.
rotationX	Определяет угол поворота вытянутой фигуры вокруг оси X в градусах.
rotationY	Определяет угол поворота вытянутой фигуры вокруг оси Y в градусах.
rotationZ	Определяет угол поворота камеры по оси Z.
z	Определяет положение фигуры по оси Z.

Методы

incrementRotationHorizontal(increment)	Поворот фигуры по оси X по горизонтали. Количество градусов для поворота.
incrementRotationVertical(increment)	Поворот фигуры по оси Y по вертикали. Количество градусов для поворота.
incrementRotationX(increment)	Поворот вокруг оси X. Количество градусов для поворота.
incrementRotationY(increment)	Поворот вокруг оси Y. Количество градусов для поворота.
incrementRotationZ(increment)	Поворот фигуры по оси Z. Количество градусов для поворота.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
resetRotation()	Сбрасывает вращение экструзии вокруг осей X, Y и Z равным 0.
set(properties, options)	Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.
set(properties)	Одновременно задает несколько свойств объекта на основе существующего загруженного объекта.
setExtrusionDirection(presetExtrusionDirection)	Направление траектории развертки выдавливания.
setExtrusionDirection(presetExtrusionDirection)	Направление траектории развертки выдавливания.
setPresetCamera(presetCamera)	Задает предустановку камеры для фигуры. Тип готовой установки.
setPresetCamera(presetCamera)	Задает предустановку камеры для фигуры. Тип готовой установки.
setThreeDimensionalFormat(presetThreeDimensionalFormat)	Задает формат выдавливания. Готовый формат.
setThreeDimensionalFormat(presetThreeDimensionalFormat)	Задает формат выдавливания. Готовый формат.
toJSON()	Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.ThreeDimensionalFormat объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Word.Interfaces.ThreeDimensionalFormatData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.
track()	Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех .sync вызовах и вне последовательного выполнения пакета ".run" и получаете сообщение об ошибке "InvalidObjectPath" при установке свойства или вызове метода объекта, необходимо добавить объект в коллекцию отслеживаемых объектов при его первом создании. Если этот объект является частью семейства, следует также отслеживать родительскую коллекцию.
untrack()	Освобождает память, связанную с этим объектом, если он ранее отслеживался. Этот вызов является сокращением от context.trackedObjects.remove(thisObject). Наличие большого количества отслеживаемых объектов замедляет ведущее приложение, поэтому не забывайте освобождать любые добавленные объекты после завершения их использования. Вам нужно позвонить context.sync() , прежде чем освобождение памяти вступит в силу.

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

bevelBottomDepth

Задает глубину нижнего скоса.

bevelBottomDepth: number;

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

number

Комментарии

Набор API: WordApiDesktop 1.3

bevelBottomInset

Задает размер отступа для нижней скосы.

bevelBottomInset: number;

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

number

Комментарии

Набор API: WordApiDesktop 1.3

bevelBottomType

Задает BevelType значение, представляющее тип скоса для нижнего скоса.

bevelBottomType: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco";

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

Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"

Комментарии

Набор API: WordApiDesktop 1.3

bevelTopDepth

Задает глубину верхнего скоса.

bevelTopDepth: number;

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

number

Комментарии

Набор API: WordApiDesktop 1.3

bevelTopInset

Задает размер отступа для верхнего скоса.

bevelTopInset: number;

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

number

Комментарии

Набор API: WordApiDesktop 1.3

bevelTopType

Задает BevelType значение, представляющее тип скоса для верхнего скоса.

bevelTopType: Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco";

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

Word.BevelType | "mixed" | "none" | "relaxedInset" | "circle" | "slope" | "cross" | "angle" | "softRound" | "convex" | "coolSlant" | "divot" | "riblet" | "hardEdge" | "artDeco"

Комментарии

Набор API: WordApiDesktop 1.3

context

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

context: RequestContext;

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

Word.RequestContext

contourColor

Возвращает объект, ColorFormat который представляет цвет контура фигуры.

readonly contourColor: Word.ColorFormat;

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

Word.ColorFormat

Комментарии

Набор API: WordApiDesktop 1.3

contourWidth

Определяет ширину контура фигуры.

contourWidth: number;

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

number

Комментарии

Набор API: WordApiDesktop 1.3

depth

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

depth: number;

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

number

Комментарии

Набор API: WordApiDesktop 1.3

extrusionColor

Возвращает объект, ColorFormat представляющий цвет выдавливания фигуры.

readonly extrusionColor: Word.ColorFormat;

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

Word.ColorFormat

Комментарии

Набор API: WordApiDesktop 1.3

extrusionColorType

Указывает, зависит ли цвет вытягивания от заливки вытянутой фигуры (лицевой поверхности выдавливания) и изменяется ли автоматически при изменении заливки фигуры или же цвет вытягивания не зависит от заливки фигуры.

extrusionColorType: Word.ExtrusionColorType | "mixed" | "automatic" | "custom";

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

Word.ExtrusionColorType | "mixed" | "automatic" | "custom"

Комментарии

Набор API: WordApiDesktop 1.3

fieldOfView

Определяет величину перспективы для фигуры.

fieldOfView: number;

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

number

Комментарии

Набор API: WordApiDesktop 1.3

isPerspective

Определяет true , выглядит ли вытягивание в перспективе, то есть если стенки вытягивания сужаются к точке схода, false если вытягивание является параллельной или ортографической проекцией, то есть если стены не сужаются к точке схода.

isPerspective: boolean;

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

boolean

Комментарии

Набор API: WordApiDesktop 1.3

isVisible

Указывает, виден ли указанный объект или примененное к нему форматирование.

isVisible: boolean;

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

boolean

Комментарии

Набор API: WordApiDesktop 1.3

lightAngle

Определяет угол освещения.

lightAngle: number;

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

number

Комментарии

Набор API: WordApiDesktop 1.3

presetCamera

Возвращает PresetCamera значение, представляющее предустановки камеры.

readonly presetCamera: Word.PresetCamera | "Mixed" | "LegacyObliqueTopLeft" | "LegacyObliqueTop" | "LegacyObliqueTopRight" | "LegacyObliqueLeft" | "LegacyObliqueFront" | "LegacyObliqueRight" | "LegacyObliqueBottomLeft" | "LegacyObliqueBottom" | "LegacyObliqueBottomRight" | "LegacyPerspectiveTopLeft" | "LegacyPerspectiveTop" | "LegacyPerspectiveTopRight" | "LegacyPerspectiveLeft" | "LegacyPerspectiveFront" | "LegacyPerspectiveRight" | "LegacyPerspectiveBottomLeft" | "LegacyPerspectiveBottom" | "LegacyPerspectiveBottomRight" | "OrthographicFront" | "IsometricTopUp" | "IsometricTopDown" | "IsometricBottomUp" | "IsometricBottomDown" | "IsometricLeftUp" | "IsometricLeftDown" | "IsometricRightUp" | "IsometricRightDown" | "IsometricOffAxis1Left" | "IsometricOffAxis1Right" | "IsometricOffAxis1Top" | "IsometricOffAxis2Left" | "IsometricOffAxis2Right" | "IsometricOffAxis2Top" | "IsometricOffAxis3Left" | "IsometricOffAxis3Right" | "IsometricOffAxis3Bottom" | "IsometricOffAxis4Left" | "IsometricOffAxis4Right" | "IsometricOffAxis4Bottom" | "ObliqueTopLeft" | "ObliqueTop" | "ObliqueTopRight" | "ObliqueLeft" | "ObliqueRight" | "ObliqueBottomLeft" | "ObliqueBottom" | "ObliqueBottomRight" | "PerspectiveFront" | "PerspectiveLeft" | "PerspectiveRight" | "PerspectiveAbove" | "PerspectiveBelow" | "PerspectiveAboveLeftFacing" | "PerspectiveAboveRightFacing" | "PerspectiveContrastingLeftFacing" | "PerspectiveContrastingRightFacing" | "PerspectiveHeroicLeftFacing" | "PerspectiveHeroicRightFacing" | "PerspectiveHeroicExtremeLeftFacing" | "PerspectiveHeroicExtremeRightFacing" | "PerspectiveRelaxed" | "PerspectiveRelaxedModerately";

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

Word.PresetCamera | "Mixed" | "LegacyObliqueTopLeft" | "LegacyObliqueTop" | "LegacyObliqueTopRight" | "LegacyObliqueLeft" | "LegacyObliqueFront" | "LegacyObliqueRight" | "LegacyObliqueBottomLeft" | "LegacyObliqueBottom" | "LegacyObliqueBottomRight" | "LegacyPerspectiveTopLeft" | "LegacyPerspectiveTop" | "LegacyPerspectiveTopRight" | "LegacyPerspectiveLeft" | "LegacyPerspectiveFront" | "LegacyPerspectiveRight" | "LegacyPerspectiveBottomLeft" | "LegacyPerspectiveBottom" | "LegacyPerspectiveBottomRight" | "OrthographicFront" | "IsometricTopUp" | "IsometricTopDown" | "IsometricBottomUp" | "IsometricBottomDown" | "IsometricLeftUp" | "IsometricLeftDown" | "IsometricRightUp" | "IsometricRightDown" | "IsometricOffAxis1Left" | "IsometricOffAxis1Right" | "IsometricOffAxis1Top" | "IsometricOffAxis2Left" | "IsometricOffAxis2Right" | "IsometricOffAxis2Top" | "IsometricOffAxis3Left" | "IsometricOffAxis3Right" | "IsometricOffAxis3Bottom" | "IsometricOffAxis4Left" | "IsometricOffAxis4Right" | "IsometricOffAxis4Bottom" | "ObliqueTopLeft" | "ObliqueTop" | "ObliqueTopRight" | "ObliqueLeft" | "ObliqueRight" | "ObliqueBottomLeft" | "ObliqueBottom" | "ObliqueBottomRight" | "PerspectiveFront" | "PerspectiveLeft" | "PerspectiveRight" | "PerspectiveAbove" | "PerspectiveBelow" | "PerspectiveAboveLeftFacing" | "PerspectiveAboveRightFacing" | "PerspectiveContrastingLeftFacing" | "PerspectiveContrastingRightFacing" | "PerspectiveHeroicLeftFacing" | "PerspectiveHeroicRightFacing" | "PerspectiveHeroicExtremeLeftFacing" | "PerspectiveHeroicExtremeRightFacing" | "PerspectiveRelaxed" | "PerspectiveRelaxedModerately"

Комментарии

Набор API: WordApiDesktop 1.3

presetExtrusionDirection

Возвращает направление траектории вытягивания от вытянутой фигуры (лицевая поверхность выдавливания).

readonly presetExtrusionDirection: Word.PresetExtrusionDirection | "Mixed" | "BottomRight" | "Bottom" | "BottomLeft" | "Right" | "None" | "Left" | "TopRight" | "Top" | "TopLeft";

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

Word.PresetExtrusionDirection | "Mixed" | "BottomRight" | "Bottom" | "BottomLeft" | "Right" | "None" | "Left" | "TopRight" | "Top" | "TopLeft"

Комментарии

Набор API: WordApiDesktop 1.3

presetLighting

Задает LightRigType значение, представляющее предустановку освещения.

presetLighting: Word.LightRigType | "Mixed" | "LegacyFlat1" | "LegacyFlat2" | "LegacyFlat3" | "LegacyFlat4" | "LegacyNormal1" | "LegacyNormal2" | "LegacyNormal3" | "LegacyNormal4" | "LegacyHarsh1" | "LegacyHarsh2" | "LegacyHarsh3" | "LegacyHarsh4" | "ThreePoint" | "Balanced" | "Soft" | "Harsh" | "Flood" | "Contrasting" | "Morning" | "Sunrise" | "Sunset" | "Chilly" | "Freezing" | "Flat" | "TwoPoint" | "Glow" | "BrightRoom";

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

Word.LightRigType | "Mixed" | "LegacyFlat1" | "LegacyFlat2" | "LegacyFlat3" | "LegacyFlat4" | "LegacyNormal1" | "LegacyNormal2" | "LegacyNormal3" | "LegacyNormal4" | "LegacyHarsh1" | "LegacyHarsh2" | "LegacyHarsh3" | "LegacyHarsh4" | "ThreePoint" | "Balanced" | "Soft" | "Harsh" | "Flood" | "Contrasting" | "Morning" | "Sunrise" | "Sunset" | "Chilly" | "Freezing" | "Flat" | "TwoPoint" | "Glow" | "BrightRoom"

Комментарии

Набор API: WordApiDesktop 1.3

presetLightingDirection

Определяет положение источника света относительно выдавливания.

presetLightingDirection: Word.PresetLightingDirection | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "None" | "Right" | "BottomLeft" | "Bottom" | "BottomRight";

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

Word.PresetLightingDirection | "Mixed" | "TopLeft" | "Top" | "TopRight" | "Left" | "None" | "Right" | "BottomLeft" | "Bottom" | "BottomRight"

Комментарии

Набор API: WordApiDesktop 1.3

presetLightingSoftness

Определяет интенсивность экструзионного освещения.

presetLightingSoftness: Word.PresetLightingSoftness | "Mixed" | "Dim" | "Normal" | "Bright";

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

Word.PresetLightingSoftness | "Mixed" | "Dim" | "Normal" | "Bright"

Комментарии

Набор API: WordApiDesktop 1.3

presetMaterial

Определяет материал поверхности выдавливания.

presetMaterial: Word.PresetMaterial | "Mixed" | "Matte" | "Plastic" | "Metal" | "WireFrame" | "Matte2" | "Plastic2" | "Metal2" | "WarmMatte" | "TranslucentPowder" | "Powder" | "DarkEdge" | "SoftEdge" | "Clear" | "Flat" | "SoftMetal";

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

Word.PresetMaterial | "Mixed" | "Matte" | "Plastic" | "Metal" | "WireFrame" | "Matte2" | "Plastic2" | "Metal2" | "WarmMatte" | "TranslucentPowder" | "Powder" | "DarkEdge" | "SoftEdge" | "Clear" | "Flat" | "SoftMetal"

Комментарии

Набор API: WordApiDesktop 1.3

presetThreeDimensionalFormat

Возвращает предустановленный формат экструзии.

readonly presetThreeDimensionalFormat: Word.PresetThreeDimensionalFormat | "Mixed" | "Format1" | "Format2" | "Format3" | "Format4" | "Format5" | "Format6" | "Format7" | "Format8" | "Format9" | "Format10" | "Format11" | "Format12" | "Format13" | "Format14" | "Format15" | "Format16" | "Format17" | "Format18" | "Format19" | "Format20";

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

Word.PresetThreeDimensionalFormat | "Mixed" | "Format1" | "Format2" | "Format3" | "Format4" | "Format5" | "Format6" | "Format7" | "Format8" | "Format9" | "Format10" | "Format11" | "Format12" | "Format13" | "Format14" | "Format15" | "Format16" | "Format17" | "Format18" | "Format19" | "Format20"

Комментарии

Набор API: WordApiDesktop 1.3

projectText

Определяет, будет ли текст на фигуре поворачиваться вместе с фигурой. true Поворот текста.

projectText: boolean;

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

boolean

Комментарии

Набор API: WordApiDesktop 1.3

rotationX

Определяет угол поворота вытянутой фигуры вокруг оси X в градусах.

rotationX: number;

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

number

Комментарии

Набор API: WordApiDesktop 1.3

rotationY

Определяет угол поворота вытянутой фигуры вокруг оси Y в градусах.

rotationY: number;

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

number

Комментарии

Набор API: WordApiDesktop 1.3

rotationZ

Определяет угол поворота камеры по оси Z.

rotationZ: number;

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

number

Комментарии

Набор API: WordApiDesktop 1.3

z

Определяет положение фигуры по оси Z.

z: number;

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

number

Комментарии

Набор API: WordApiDesktop 1.3

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

incrementRotationHorizontal(increment)

Поворот фигуры по оси X по горизонтали. Количество градусов для поворота.

incrementRotationHorizontal(increment: number): void;

Параметры

increment

number

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

void

Комментарии

Набор API: WordApiDesktop 1.3

incrementRotationVertical(increment)

Поворот фигуры по оси Y по вертикали. Количество градусов для поворота.

incrementRotationVertical(increment: number): void;

Параметры

increment

number

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

void

Комментарии

Набор API: WordApiDesktop 1.3

incrementRotationX(increment)

Поворот вокруг оси X. Количество градусов для поворота.

incrementRotationX(increment: number): void;

Параметры

increment

number

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

void

Комментарии

Набор API: WordApiDesktop 1.3

incrementRotationY(increment)

Поворот вокруг оси Y. Количество градусов для поворота.

incrementRotationY(increment: number): void;

Параметры

increment

number

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

void

Комментарии

Набор API: WordApiDesktop 1.3

incrementRotationZ(increment)

Поворот фигуры по оси Z. Количество градусов для поворота.

incrementRotationZ(increment: number): void;

Параметры

increment

number

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

void

Комментарии

Набор API: WordApiDesktop 1.3

load(options)

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

load(options?: Word.Interfaces.ThreeDimensionalFormatLoadOptions): Word.ThreeDimensionalFormat;

Параметры

options

Word.Interfaces.ThreeDimensionalFormatLoadOptions

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

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

Word.ThreeDimensionalFormat

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Word.ThreeDimensionalFormat

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

Word.ThreeDimensionalFormat

resetRotation()

Сбрасывает вращение экструзии вокруг осей X, Y и Z равным 0.

resetRotation(): void;

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

void

Комментарии

Набор API: WordApiDesktop 1.3

set(properties, options)

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

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

Параметры

properties

Word.Interfaces.ThreeDimensionalFormatUpdateData

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

options

OfficeExtension.UpdateOptions

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

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

void

set(properties)

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

set(properties: Word.ThreeDimensionalFormat): void;

Параметры

properties

Word.ThreeDimensionalFormat

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

void

setExtrusionDirection(presetExtrusionDirection)

Направление траектории развертки выдавливания.

setExtrusionDirection(presetExtrusionDirection: Word.PresetExtrusionDirection): void;

Параметры

presetExtrusionDirection

Word.PresetExtrusionDirection

Предустановленное направление.

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

void

Комментарии

Набор API: WordApiDesktop 1.3

setExtrusionDirection(presetExtrusionDirection)

Направление траектории развертки выдавливания.

setExtrusionDirection(presetExtrusionDirection: "Mixed" | "BottomRight" | "Bottom" | "BottomLeft" | "Right" | "None" | "Left" | "TopRight" | "Top" | "TopLeft"): void;

Параметры

presetExtrusionDirection

"Mixed" | "BottomRight" | "Bottom" | "BottomLeft" | "Right" | "None" | "Left" | "TopRight" | "Top" | "TopLeft"

Предустановленное направление.

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

void

Комментарии

Набор API: WordApiDesktop 1.3

setPresetCamera(presetCamera)

Задает предустановку камеры для фигуры. Тип готовой установки.

setPresetCamera(presetCamera: Word.PresetCamera): void;

Параметры

presetCamera

Word.PresetCamera

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

void

Комментарии

Набор API: WordApiDesktop 1.3

setPresetCamera(presetCamera)

Задает предустановку камеры для фигуры. Тип готовой установки.

setPresetCamera(presetCamera: "Mixed" | "LegacyObliqueTopLeft" | "LegacyObliqueTop" | "LegacyObliqueTopRight" | "LegacyObliqueLeft" | "LegacyObliqueFront" | "LegacyObliqueRight" | "LegacyObliqueBottomLeft" | "LegacyObliqueBottom" | "LegacyObliqueBottomRight" | "LegacyPerspectiveTopLeft" | "LegacyPerspectiveTop" | "LegacyPerspectiveTopRight" | "LegacyPerspectiveLeft" | "LegacyPerspectiveFront" | "LegacyPerspectiveRight" | "LegacyPerspectiveBottomLeft" | "LegacyPerspectiveBottom" | "LegacyPerspectiveBottomRight" | "OrthographicFront" | "IsometricTopUp" | "IsometricTopDown" | "IsometricBottomUp" | "IsometricBottomDown" | "IsometricLeftUp" | "IsometricLeftDown" | "IsometricRightUp" | "IsometricRightDown" | "IsometricOffAxis1Left" | "IsometricOffAxis1Right" | "IsometricOffAxis1Top" | "IsometricOffAxis2Left" | "IsometricOffAxis2Right" | "IsometricOffAxis2Top" | "IsometricOffAxis3Left" | "IsometricOffAxis3Right" | "IsometricOffAxis3Bottom" | "IsometricOffAxis4Left" | "IsometricOffAxis4Right" | "IsometricOffAxis4Bottom" | "ObliqueTopLeft" | "ObliqueTop" | "ObliqueTopRight" | "ObliqueLeft" | "ObliqueRight" | "ObliqueBottomLeft" | "ObliqueBottom" | "ObliqueBottomRight" | "PerspectiveFront" | "PerspectiveLeft" | "PerspectiveRight" | "PerspectiveAbove" | "PerspectiveBelow" | "PerspectiveAboveLeftFacing" | "PerspectiveAboveRightFacing" | "PerspectiveContrastingLeftFacing" | "PerspectiveContrastingRightFacing" | "PerspectiveHeroicLeftFacing" | "PerspectiveHeroicRightFacing" | "PerspectiveHeroicExtremeLeftFacing" | "PerspectiveHeroicExtremeRightFacing" | "PerspectiveRelaxed" | "PerspectiveRelaxedModerately"): void;

Параметры

presetCamera

"Mixed" | "LegacyObliqueTopLeft" | "LegacyObliqueTop" | "LegacyObliqueTopRight" | "LegacyObliqueLeft" | "LegacyObliqueFront" | "LegacyObliqueRight" | "LegacyObliqueBottomLeft" | "LegacyObliqueBottom" | "LegacyObliqueBottomRight" | "LegacyPerspectiveTopLeft" | "LegacyPerspectiveTop" | "LegacyPerspectiveTopRight" | "LegacyPerspectiveLeft" | "LegacyPerspectiveFront" | "LegacyPerspectiveRight" | "LegacyPerspectiveBottomLeft" | "LegacyPerspectiveBottom" | "LegacyPerspectiveBottomRight" | "OrthographicFront" | "IsometricTopUp" | "IsometricTopDown" | "IsometricBottomUp" | "IsometricBottomDown" | "IsometricLeftUp" | "IsometricLeftDown" | "IsometricRightUp" | "IsometricRightDown" | "IsometricOffAxis1Left" | "IsometricOffAxis1Right" | "IsometricOffAxis1Top" | "IsometricOffAxis2Left" | "IsometricOffAxis2Right" | "IsometricOffAxis2Top" | "IsometricOffAxis3Left" | "IsometricOffAxis3Right" | "IsometricOffAxis3Bottom" | "IsometricOffAxis4Left" | "IsometricOffAxis4Right" | "IsometricOffAxis4Bottom" | "ObliqueTopLeft" | "ObliqueTop" | "ObliqueTopRight" | "ObliqueLeft" | "ObliqueRight" | "ObliqueBottomLeft" | "ObliqueBottom" | "ObliqueBottomRight" | "PerspectiveFront" | "PerspectiveLeft" | "PerspectiveRight" | "PerspectiveAbove" | "PerspectiveBelow" | "PerspectiveAboveLeftFacing" | "PerspectiveAboveRightFacing" | "PerspectiveContrastingLeftFacing" | "PerspectiveContrastingRightFacing" | "PerspectiveHeroicLeftFacing" | "PerspectiveHeroicRightFacing" | "PerspectiveHeroicExtremeLeftFacing" | "PerspectiveHeroicExtremeRightFacing" | "PerspectiveRelaxed" | "PerspectiveRelaxedModerately"

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

void

Комментарии

Набор API: WordApiDesktop 1.3

setThreeDimensionalFormat(presetThreeDimensionalFormat)

Задает формат выдавливания. Готовый формат.

setThreeDimensionalFormat(presetThreeDimensionalFormat: Word.PresetThreeDimensionalFormat): void;

Параметры

presetThreeDimensionalFormat

Word.PresetThreeDimensionalFormat

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

void

Комментарии

Набор API: WordApiDesktop 1.3

setThreeDimensionalFormat(presetThreeDimensionalFormat)

Задает формат выдавливания. Готовый формат.

setThreeDimensionalFormat(presetThreeDimensionalFormat: "Mixed" | "Format1" | "Format2" | "Format3" | "Format4" | "Format5" | "Format6" | "Format7" | "Format8" | "Format9" | "Format10" | "Format11" | "Format12" | "Format13" | "Format14" | "Format15" | "Format16" | "Format17" | "Format18" | "Format19" | "Format20"): void;

Параметры

presetThreeDimensionalFormat

"Mixed" | "Format1" | "Format2" | "Format3" | "Format4" | "Format5" | "Format6" | "Format7" | "Format8" | "Format9" | "Format10" | "Format11" | "Format12" | "Format13" | "Format14" | "Format15" | "Format16" | "Format17" | "Format18" | "Format19" | "Format20"

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

void

Комментарии

Набор API: WordApiDesktop 1.3

toJSON()

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

toJSON(): Word.Interfaces.ThreeDimensionalFormatData;

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

Word.Interfaces.ThreeDimensionalFormatData

track()

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

track(): Word.ThreeDimensionalFormat;

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

Word.ThreeDimensionalFormat

untrack()

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

untrack(): Word.ThreeDimensionalFormat;

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

Word.ThreeDimensionalFormat