Excel.ShapeLineFormat class
Representa a formatação de linha para o objeto shape. Para imagens e formas geométricas, a formatação de linha representa a borda da forma.
- Extends
Comentários
[ Conjunto de API: ExcelApi 1.9 ]
Propriedades
color | Representa a cor da linha no formato de cor HTML, no formulário #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. |
dash |
Representa o estilo de linha da forma. Retorna |
style | Representa o estilo de linha da forma. Retorna |
transparency | Representa o grau de transparência da linha especificada como um valor de 0,0 (opaco) a 1,0 (claro). Retorna |
visible | Especifica se a formatação de linha de um elemento de forma está visível. Retorna |
weight | Representa a espessura da linha, em pontos. Retorna |
Métodos
load(options) | Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
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 |
Detalhes da propriedade
color
Representa a cor da linha no formato de cor HTML, no formulário #RRGGBB (por exemplo, "FFA500") ou como uma cor HTML nomeada (por exemplo, "laranja").
color: string;
Valor da propriedade
string
Comentários
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
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. Confira Excel.ShapeLineDashStyle
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
style
Representa o estilo de linha da forma. Retorna null
quando a linha não está visível ou há estilos inconsistentes. Confira Excel.ShapeLineStyle
detalhes.
style: Excel.ShapeLineStyle | "Single" | "ThickBetweenThin" | "ThickThin" | "ThinThick" | "ThinThin";
Valor da propriedade
Excel.ShapeLineStyle | "Single" | "ThickBetweenThin" | "ThickThin" | "ThinThick" | "ThinThin"
Comentários
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
visible
Especifica se a formatação de linha de um elemento de forma está visível. Retorna null
quando a forma tem visibilidades inconsistentes.
visible: boolean;
Valor da propriedade
boolean
Comentários
weight
Representa a espessura da linha, em pontos. Retorna null
quando a linha não está visível ou há pesos de linha inconsistentes.
weight: number;
Valor da propriedade
number
Comentários
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
Fornece opções para quais propriedades do objeto 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[]): Excel.ShapeLineFormat;
Parâmetros
- propertyNames
-
string | string[]
Uma cadeia de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.
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;
}): Excel.ShapeLineFormat;
Parâmetros
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select
é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand
é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades de navegação a serem carregadas.
Retornos
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 properties tentar definir quaisquer 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 Excel.ShapeLineFormat original é um objeto API, o toJSON
método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.ShapeLineFormatData
) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.
toJSON(): Excel.Interfaces.ShapeLineFormatData;
Retornos
Comentários
https://aka.ms/ContentUserFeedback.
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulteEnviar e exibir comentários de