Поделиться через

Word.ThreeDimensionalFormat class

Пакет:
word

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

Extends
OfficeExtension.ClientObject

Комментарии

[ Набор API: WordApiDesktop 1.3 ]

Свойства

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

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

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

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