Compartilhar via


Word.LineFormat class

Representa formatação de linha e ponta de seta. Para uma linha, o LineFormat objeto contém informações de formatação para a própria linha; para uma forma com um limite, este objeto contém informações de formatação para o limite da forma.

Extends

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Propriedades

backgroundColor

Obtém um ColorFormat objeto que representa a cor de fundo de uma linha padronizada.

beginArrowheadLength

Especifica o comprimento da ponta da seta no início da linha.

beginArrowheadStyle

Especifica o estilo da ponta da seta no início da linha.

beginArrowheadWidth

Especifica a largura da ponta da seta no início da linha.

context

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.

dashStyle

Especifica o estilo de traço para a linha.

endArrowheadLength

Especifica o comprimento da ponta da seta no final da linha.

endArrowheadStyle

Especifica o estilo da ponta da seta no final da linha.

endArrowheadWidth

Especifica a largura da ponta da seta no final da linha.

foregroundColor

Obtém um ColorFormat objeto que representa a cor de primeiro plano da linha.

insetPen

Especifica se pretende desenhar linhas dentro de uma forma.

isVisible

Especifica se o objeto ou a formatação aplicada ao mesmo está visível.

pattern

Especifica o padrão aplicado à linha.

style

Especifica o estilo de formato de linha.

transparency

Especifica o grau de transparência da linha como um valor entre 0,0 (opaco) e 1,0 (claro).

weight

Especifica a espessura da linha em pontos.

Métodos

load(options)

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

load(propertyNames)

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

load(propertyNamesAndPaths)

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

set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.

set(properties)

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

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Word.LineFormat é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Word.Interfaces.LineFormatData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

track()

Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Esta chamada é uma abreviatura de context.trackedObjects.add(thisObject). Se estiver a utilizar este 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, terá de adicionar o objeto à coleção de objetos controlados quando o objeto foi criado pela primeira vez. Se este objeto fizer parte de uma coleção, também deve controlar a coleção principal.

untrack()

Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Esta chamada é abreviada para 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. Terá de chamar context.sync() antes de a libertação da memória ser aplicada.

Detalhes da propriedade

backgroundColor

Obtém um ColorFormat objeto que representa a cor de fundo de uma linha padronizada.

readonly backgroundColor: Word.ColorFormat;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

beginArrowheadLength

Especifica o comprimento da ponta da seta no início da linha.

beginArrowheadLength: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long";

Valor da propriedade

Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

beginArrowheadStyle

Especifica o estilo da ponta da seta no início da linha.

beginArrowheadStyle: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval";

Valor da propriedade

Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

beginArrowheadWidth

Especifica a largura da ponta da seta no início da linha.

beginArrowheadWidth: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide";

Valor da propriedade

Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

context

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.

context: RequestContext;

Valor da propriedade

dashStyle

Especifica o estilo de traço para a linha.

dashStyle: Word.LineDashStyle | "Mixed" | "Solid" | "SquareDot" | "RoundDot" | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "LongDashDotDot" | "SysDash" | "SysDot" | "SysDashDot";

Valor da propriedade

Word.LineDashStyle | "Mixed" | "Solid" | "SquareDot" | "RoundDot" | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "LongDashDotDot" | "SysDash" | "SysDot" | "SysDashDot"

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

endArrowheadLength

Especifica o comprimento da ponta da seta no final da linha.

endArrowheadLength: Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long";

Valor da propriedade

Word.ArrowheadLength | "Mixed" | "Short" | "Medium" | "Long"

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

endArrowheadStyle

Especifica o estilo da ponta da seta no final da linha.

endArrowheadStyle: Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval";

Valor da propriedade

Word.ArrowheadStyle | "Mixed" | "None" | "Triangle" | "Open" | "Stealth" | "Diamond" | "Oval"

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

endArrowheadWidth

Especifica a largura da ponta da seta no final da linha.

endArrowheadWidth: Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide";

Valor da propriedade

Word.ArrowheadWidth | "Mixed" | "Narrow" | "Medium" | "Wide"

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

foregroundColor

Obtém um ColorFormat objeto que representa a cor de primeiro plano da linha.

readonly foregroundColor: Word.ColorFormat;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

insetPen

Especifica se pretende desenhar linhas dentro de uma forma.

insetPen: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

isVisible

Especifica se o objeto ou a formatação aplicada ao mesmo está visível.

isVisible: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

pattern

Especifica o padrão aplicado à linha.

pattern: Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross";

Valor da propriedade

Word.PatternType | "Mixed" | "Percent5" | "Percent10" | "Percent20" | "Percent25" | "Percent30" | "Percent40" | "Percent50" | "Percent60" | "Percent70" | "Percent75" | "Percent80" | "Percent90" | "DarkHorizontal" | "DarkVertical" | "DarkDownwardDiagonal" | "DarkUpwardDiagonal" | "SmallCheckerBoard" | "Trellis" | "LightHorizontal" | "LightVertical" | "LightDownwardDiagonal" | "LightUpwardDiagonal" | "SmallGrid" | "DottedDiamond" | "WideDownwardDiagonal" | "WideUpwardDiagonal" | "DashedUpwardDiagonal" | "DashedDownwardDiagonal" | "NarrowVertical" | "NarrowHorizontal" | "DashedVertical" | "DashedHorizontal" | "LargeConfetti" | "LargeGrid" | "HorizontalBrick" | "LargeCheckerBoard" | "SmallConfetti" | "ZigZag" | "SolidDiamond" | "DiagonalBrick" | "OutlinedDiamond" | "Plaid" | "Sphere" | "Weave" | "DottedGrid" | "Divot" | "Shingle" | "Wave" | "Horizontal" | "Vertical" | "Cross" | "DownwardDiagonal" | "UpwardDiagonal" | "DiagonalCross"

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

style

Especifica o estilo de formato de linha.

style: Word.LineFormatStyle | "Mixed" | "Single" | "ThinThin" | "ThinThick" | "ThickThin" | "ThickBetweenThin";

Valor da propriedade

Word.LineFormatStyle | "Mixed" | "Single" | "ThinThin" | "ThinThick" | "ThickThin" | "ThickBetweenThin"

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

transparency

Especifica o grau de transparência da linha como um valor entre 0,0 (opaco) e 1,0 (claro).

transparency: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

weight

Especifica a espessura da linha em pontos.

weight: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Detalhes do método

load(options)

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.LineFormatLoadOptions): Word.LineFormat;

Parâmetros

options
Word.Interfaces.LineFormatLoadOptions

Fornece opções para as propriedades do objeto a carregar.

Retornos

load(propertyNames)

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.LineFormat;

Parâmetros

propertyNames

string | string[]

Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.

Retornos

load(propertyNamesAndPaths)

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.LineFormat;

Parâmetros

propertyNamesAndPaths

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

propertyNamesAndPaths.select é uma cadeia delimitada por vírgulas que especifica as propriedades a carregar e propertyNamesAndPaths.expand é uma cadeia delimitada por vírgulas que especifica as propriedades de navegação a carregar.

Retornos

set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.

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

Parâmetros

properties
Word.Interfaces.LineFormatUpdateData

Um objeto JavaScript com propriedades que são estruturadas isomorfoticamente para as propriedades do objeto no qual o método é chamado.

options
OfficeExtension.UpdateOptions

Fornece uma opção para suprimir erros se o objeto de propriedades tentar definir quaisquer propriedades só de leitura.

Retornos

void

set(properties)

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

set(properties: Word.LineFormat): void;

Parâmetros

properties
Word.LineFormat

Retornos

void

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Word.LineFormat é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Word.Interfaces.LineFormatData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): Word.Interfaces.LineFormatData;

Retornos

track()

Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Esta chamada é uma abreviatura de context.trackedObjects.add(thisObject). Se estiver a utilizar este 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, terá de adicionar o objeto à coleção de objetos controlados quando o objeto foi criado pela primeira vez. Se este objeto fizer parte de uma coleção, também deve controlar a coleção principal.

track(): Word.LineFormat;

Retornos

untrack()

Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Esta chamada é abreviada para 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. Terá de chamar context.sync() antes de a libertação da memória ser aplicada.

untrack(): Word.LineFormat;

Retornos