Excel.HeaderFooterPicture class
Representa uma imagem no cabeçalho ou rodapé de uma folha de cálculo.
- Extends
Comentários
Propriedades
| brightness | Especifica a luminosidade da imagem. O valor dessa propriedade deve ser um número de 0,0 (mais esmaecido) a 1,0 (mais brilhante). |
| color |
Especifica o tipo de transformação de cor da imagem. |
| context | O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office. |
| contrast | Especifica o contraste da imagem. O valor desta propriedade tem de ser um número de 0,0 (mínimo contraste) para 1,0 (maior contraste). |
| crop |
Especifica o número de pontos que são recortados na parte inferior da imagem. |
| crop |
Especifica o número de pontos que são recortados do lado esquerdo da imagem. |
| crop |
Especifica o número de pontos que são recortados no lado direito da imagem. |
| crop |
Especifica o número de pontos que são recortados na parte superior da imagem. |
| filename | Especifica o URL (na intranet ou na Web) ou o caminho (local ou rede) para a localização onde o objeto de origem é guardado. |
| height | Especifica a altura da imagem em pontos. |
| lock |
Especifica um valor que indica se a imagem mantém as proporções originais quando redimensionada.
|
| width | Especifica a largura da imagem em pontos. |
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. 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 |
Detalhes da propriedade
brightness
Especifica a luminosidade da imagem. O valor dessa propriedade deve ser um número de 0,0 (mais esmaecido) a 1,0 (mais brilhante).
brightness: number;Valor da propriedade
number
Comentários
colorType
Especifica o tipo de transformação de cor da imagem.
colorType: Excel.PictureColorType | "Mixed" | "Automatic" | "GrayScale" | "BlackAndWhite" | "Watermark";Valor da propriedade
Excel.PictureColorType | "Mixed" | "Automatic" | "GrayScale" | "BlackAndWhite" | "Watermark"
Comentários
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
contrast
Especifica o contraste da imagem. O valor desta propriedade tem de ser um número de 0,0 (mínimo contraste) para 1,0 (maior contraste).
contrast: number;Valor da propriedade
number
Comentários
cropBottom
Especifica o número de pontos que são recortados na parte inferior da imagem.
cropBottom: number;Valor da propriedade
number
Comentários
cropLeft
Especifica o número de pontos que são recortados do lado esquerdo da imagem.
cropLeft: number;Valor da propriedade
number
Comentários
cropRight
Especifica o número de pontos que são recortados no lado direito da imagem.
cropRight: number;Valor da propriedade
number
Comentários
cropTop
Especifica o número de pontos que são recortados na parte superior da imagem.
cropTop: number;Valor da propriedade
number
Comentários
filename
Especifica o URL (na intranet ou na Web) ou o caminho (local ou rede) para a localização onde o objeto de origem é guardado.
filename: string;Valor da propriedade
string
Comentários
height
Especifica a altura da imagem em pontos.
height: number;Valor da propriedade
number
Comentários
lockAspectRatio
Especifica um valor que indica se a imagem mantém as proporções originais quando redimensionada.
true se mantiver as suas proporções; caso contrário, false.
lockAspectRatio: boolean;Valor da propriedade
boolean
Comentários
width
Especifica a largura da imagem em pontos.
width: 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.HeaderFooterPictureLoadOptions): Excel.HeaderFooterPicture;Parâmetros
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[]): Excel.HeaderFooterPicture;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;
}): Excel.HeaderFooterPicture;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.HeaderFooterPictureUpdateData, options?: OfficeExtension.UpdateOptions): void;Parâmetros
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: Excel.HeaderFooterPicture): void;Parâmetros
- properties
- Excel.HeaderFooterPicture
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 Excel.HeaderFooterPicture é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.HeaderFooterPictureData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
toJSON(): Excel.Interfaces.HeaderFooterPictureData;