Word.ColorFormat class

Especifica a luminosidade de uma cor de forma especificada. Os valores válidos são dos -1 (mais escuros) aos 1 (mais claros) 0 que representam neutros.

brightness: number;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

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

Especifica a cor do tema para um formato de cor.

objectThemeColor: Word.ThemeColorIndex | "NotThemeColor" | "MainDark1" | "MainLight1" | "MainDark2" | "MainLight2" | "Accent1" | "Accent2" | "Accent3" | "Accent4" | "Accent5" | "Accent6" | "Hyperlink" | "HyperlinkFollowed" | "Background1" | "Text1" | "Background2" | "Text2";

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Especifica o valor vermelho-verde-azul (RGB) da cor especificada. Pode fornecer o valor no formato "#RRGGBB".

rgb: string;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Especifica a luminosidade ou o escudamento da cor de uma forma especificada. Os valores válidos são dos -1 (mais escuros) aos 1 (mais claros) 0 que representam neutros.

tintAndShade: number;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Devolve o tipo de cor da forma.

readonly type: Word.ColorType | "rgb" | "scheme";

Valor da propriedade

Comentários

[ Conjunto de API: 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.ColorFormatLoadOptions): Word.ColorFormat;

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

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

Parâmetros

Retornos

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

Parâmetros

Retornos

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

set(properties: Word.ColorFormat): void;

Parâmetros

Retornos

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.ColorFormat é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Word.Interfaces.ColorFormatData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): Word.Interfaces.ColorFormatData;

Retornos

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

Retornos

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

Retornos