Excel.ShapeLineFormat class

Pacote:
excel

Representa a formatação de linha para o objeto de forma. Para imagens e formas geométricas, a formatação de linha representa a borda da forma.

Extends
OfficeExtension.ClientObject

Comentários

[Conjunto de apis: ExcelApi 1.9]

Propriedades

color

Representa a cor da linha no formato de cor HTML, no formato #RRGGBB (por exemplo, "FFA500") ou como uma cor HTML nomeada (por exemplo, "laranja").
context

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

Representa o estilo de linha da forma. Retorna null quando a linha não está visível ou há estilos de traço inconsistentes. Consulte Excel.ShapeLineDashStyle para obter detalhes.
style

Representa o estilo de linha da forma. Retorna null quando a linha não está visível ou há estilos inconsistentes. Consulte Excel.ShapeLineStyle para obter detalhes.
transparency

Representa o grau de transparência da linha especificada como um valor de 0,0 (opaco) a 1,0 (claro). Retorna null quando a forma tem transparências inconsistentes.
visible

Especifica se a formatação de linha de um elemento de forma é visível. Retorna null quando a forma tem visibilidades inconsistentes.
weight

Representa a espessura da linha, em pontos. Retorna null quando a linha não está visível ou há espessuras de linha inconsistentes.

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. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.
set(properties)

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

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 Excel.ShapeLineFormat é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.ShapeLineFormatData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.

Detalhes da propriedade

color

Representa a cor da linha no formato de cor HTML, no formato #RRGGBB (por exemplo, "FFA500") ou como uma cor HTML nomeada (por exemplo, "laranja").

color: string;

Valor da propriedade

string

Comentários

[Conjunto de apis: ExcelApi 1.9]

context

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

Excel.RequestContext

dashStyle

Representa o estilo de linha da forma. Retorna null quando a linha não está visível ou há estilos de traço inconsistentes. Consulte Excel.ShapeLineDashStyle para obter detalhes.

dashStyle: Excel.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot";

Valor da propriedade

Excel.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot"

Comentários

[Conjunto de apis: ExcelApi 1.9]

style

Representa o estilo de linha da forma. Retorna null quando a linha não está visível ou há estilos inconsistentes. Consulte Excel.ShapeLineStyle para obter detalhes.

style: Excel.ShapeLineStyle | "Single" | "ThickBetweenThin" | "ThickThin" | "ThinThick" | "ThinThin";

Valor da propriedade

Excel.ShapeLineStyle | "Single" | "ThickBetweenThin" | "ThickThin" | "ThinThick" | "ThinThin"

Comentários

[Conjunto de apis: ExcelApi 1.9]

transparency

Representa o grau de transparência da linha especificada como um valor de 0,0 (opaco) a 1,0 (claro). Retorna null quando a forma tem transparências inconsistentes.

transparency: number;

Valor da propriedade

number

Comentários

[Conjunto de apis: ExcelApi 1.9]

visible

Especifica se a formatação de linha de um elemento de forma é visível. Retorna null quando a forma tem visibilidades inconsistentes.

visible: boolean;

Valor da propriedade

boolean

Comentários

[Conjunto de apis: ExcelApi 1.9]

weight

Representa a espessura da linha, em pontos. Retorna null quando a linha não está visível ou há espessuras de linha inconsistentes.

weight: number;

Valor da propriedade

number

Comentários

[Conjunto de apis: ExcelApi 1.9]

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?: Excel.Interfaces.ShapeLineFormatLoadOptions): Excel.ShapeLineFormat;

Parâmetros

options
Excel.Interfaces.ShapeLineFormatLoadOptions

Fornece opções para quais propriedades do objeto devem ser carregadas.

Retornos

Excel.ShapeLineFormat

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[]): Excel.ShapeLineFormat;

Parâmetros

propertyNames

string | string[]

Uma cadeia de caracteres delimitada por vírgula ou uma matriz de cadeias de caracteres que especifica as propriedades a serem carregadas.

Retornos

Excel.ShapeLineFormat

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;
        }): Excel.ShapeLineFormat;

Parâmetros

propertyNamesAndPaths

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

propertyNamesAndPaths.select é uma cadeia de caracteres delimitada por vírgula que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgula que especifica as propriedades de navegação a serem carregadas.

Retornos

Excel.ShapeLineFormat

set(properties, options)

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.ShapeLineFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

properties
Excel.Interfaces.ShapeLineFormatUpdateData

Um objeto JavaScript com propriedades estruturadas isomorficamente 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 propriedades somente leitura.

Retornos

void

set(properties)

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

set(properties: Excel.ShapeLineFormat): void;

Parâmetros

properties
Excel.ShapeLineFormat

Retornos

void

toJSON()

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 Excel.ShapeLineFormat é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.ShapeLineFormatData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.

toJSON(): Excel.Interfaces.ShapeLineFormatData;

Retornos

Excel.Interfaces.ShapeLineFormatData