Word.ThreeDimensionalFormat class

Especifica a profundidade do chanfro inferior.

bevelBottomDepth: number;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica o tamanho da inserção do chanfro inferior.

bevelBottomInset: number;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica um BevelType valor que representa o tipo de chanfro para o chanfro inferior.

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

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica a profundidade do chanfro superior.

bevelTopDepth: number;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica o tamanho da inserção do chanfro superior.

bevelTopInset: number;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica um BevelType valor que representa o tipo de chanfro para o chanfro superior.

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

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

context: RequestContext;

Valor da propriedade

Retorna um ColorFormat objeto que representa a cor do contorno de uma forma.

readonly contourColor: Word.ColorFormat;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica a largura do contorno de uma forma.

contourWidth: number;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica a profundidade da extrusão da forma.

depth: number;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Retorna um ColorFormat objeto que representa a cor da extrusão da forma.

readonly extrusionColor: Word.ColorFormat;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica se a cor de extrusão é baseada no preenchimento da forma extrudada (a face frontal da extrusão) e alterada automaticamente quando o preenchimento da forma é alterado, ou se a cor de extrusão é independente do preenchimento da forma.

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

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica a quantidade de perspectiva de uma forma.

fieldOfView: number;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica true se a extrusão aparece em perspectiva, ou seja, se as paredes da extrusão se estreitam em direção a um ponto de fuga, false se a extrusão é uma projeção paralela ou ortográfica, ou seja, se as paredes não se estreitam em direção a um ponto de fuga.

isPerspective: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica se o objeto especificado ou a formatação aplicada a ele é visível.

isVisible: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica o ângulo da iluminação.

lightAngle: number;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Retorna um PresetCamera valor que representa as predefinições da câmera.

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";

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Retorna a direção tomada pelo caminho de varredura da extrusão líderes para longe da forma extrudada (a face frontal da extrusão).

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

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica um LightRigType valor que representa a predefinição de iluminação.

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";

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica a posição da fonte de luz em relação à extrusão.

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

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica a intensidade da iluminação de extrusão.

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

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica o material da superfície de extrusão.

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

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Retorna o formato de extrusão predefinido.

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";

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica se o texto em uma forma gira com a forma. true Gira o texto.

projectText: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica a rotação da forma extrudada em torno do eixo x, em graus.

rotationX: number;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica a rotação da forma extrudada em torno do eixo y, em graus.

rotationY: number;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica a rotação do eixo z da câmera.

rotationZ: number;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica a posição da forma no eixo z.

z: number;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Gira horizontalmente uma forma no eixo x. O número de graus a serem girados.

incrementRotationHorizontal(increment: number): void;

Parâmetros

Retornos

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Gira verticalmente uma forma no eixo y. O número de graus a serem girados.

incrementRotationVertical(increment: number): void;

Parâmetros

Retornos

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Altera a rotação em torno do eixo x. O número de graus a serem girados.

incrementRotationX(increment: number): void;

Parâmetros

Retornos

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Altera a rotação em torno do eixo y. O número de graus a serem girados.

incrementRotationY(increment: number): void;

Parâmetros

Retornos

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Gira uma forma no eixo z. O número de graus a serem girados.

incrementRotationZ(increment: number): void;

Parâmetros

Retornos

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

Retornos

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

Retornos

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

Retornos

Redefine a rotação de extrusão em torno do eixo x, do eixo y e do eixo z para 0.

resetRotation(): void;

Retornos

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.

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

Parâmetros

Retornos

Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.

set(properties: Word.ThreeDimensionalFormat): void;

Parâmetros

Retornos

Define a direção do caminho de varredura da extrusão.

setExtrusionDirection(presetExtrusionDirection: Word.PresetExtrusionDirection): void;

Parâmetros

Retornos

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Define a direção do caminho de varredura da extrusão.

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

Parâmetros

Retornos

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Define a câmera predefinida para a forma. O tipo de câmera predefinido.

setPresetCamera(presetCamera: Word.PresetCamera): void;

Parâmetros

Retornos

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Define a câmera predefinida para a forma. O tipo de câmera predefinido.

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;

Parâmetros

Retornos

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Define o formato de extrusão predefinido. O formato predefinido.

setThreeDimensionalFormat(presetThreeDimensionalFormat: Word.PresetThreeDimensionalFormat): void;

Parâmetros

Retornos

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Define o formato de extrusão predefinido. O formato predefinido.

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

Parâmetros

Retornos

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringify, por sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto original Word.ThreeDimensionalFormat é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como Word.Interfaces.ThreeDimensionalFormatData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.

toJSON(): Word.Interfaces.ThreeDimensionalFormatData;

Retornos

Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Essa chamada é uma abreviação de context.trackedObjects.add(thisObject). Se você estiver usando esse objeto entre .sync chamadas e fora da execução sequencial de um lote ".run" e receber um erro "InvalidObjectPath" ao definir uma propriedade ou invocar um método no objeto, precisará adicionar o objeto à coleção de objetos rastreados quando o objeto foi criado pela primeira vez. Se esse objeto fizer parte de uma coleção, você também deverá acompanhar a coleção pai.

track(): Word.ThreeDimensionalFormat;

Retornos

Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Essa chamada é a forma abreviada de context.trackedObjects.remove(thisObject). Ter muitos objetos rastreados desacelera o aplicativo host, por isso, lembre-se de liberar todos os objetos adicionados após usá-los. Você precisará ligar context.sync() antes que a liberação de memória entre em vigor.

untrack(): Word.ThreeDimensionalFormat;

Retornos