Word.CustomProperty class

Pacote:

word

Representa uma propriedade personalizada.

Extends

OfficeExtension.ClientObject

Comentários

[ Conjunto de API: WordApi 1.3 ]

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/30-properties/read-write-custom-document-properties.yaml

await Word.run(async (context) => {
    const properties = context.document.properties.customProperties;
    properties.load("key,type,value");

    await context.sync();
    for (let i = 0; i < properties.items.length; i++)
        console.log("Property Name:" + properties.items[i].key + "; Type=" + properties.items[i].type + "; Property Value=" + properties.items[i].value);
});

Propriedades

context	O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
key	Obtém a chave da propriedade personalizada.
type	Obtém o tipo de valor da propriedade personalizada. Os valores possíveis são: Cadeia de caracteres, número, data, booliano.
value	Especifica o valor da propriedade personalizada. Observe que, embora Word na Web e no formato de arquivo docx permitam que essas propriedades sejam arbitrariamente longas, a versão da área de trabalho do Word truncará os valores de cadeia de caracteres para chars de 255 16 bits (possivelmente criando unicódigo inválido dividindo um par de substitutos).

Métodos

delete()	Exclui a propriedade personalizada.
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.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o Word original. O objeto CustomProperty é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Word.Interfaces.CustomPropertyData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.
track()	Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Essa chamada é uma abreviação para context.trackedObjects.add(thisObject). Se você estiver usando esse 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, você precisará adicionar o objeto à coleção de objetos rastreados quando o objeto foi criado pela primeira vez. Se esse objeto fizer parte de uma coleção, você também deverá acompanhar a coleção pai.
untrack()	Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Essa 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. Você precisará chamar context.sync() antes que a versão da memória entre em vigor.

Detalhes da propriedade

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

Word.RequestContext

key

Obtém a chave da propriedade personalizada.

readonly key: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: WordApi 1.3 ]

type

Obtém o tipo de valor da propriedade personalizada. Os valores possíveis são: Cadeia de caracteres, número, data, booliano.

readonly type: Word.DocumentPropertyType | "String" | "Number" | "Date" | "Boolean";

Valor da propriedade

Word.DocumentPropertyType | "String" | "Number" | "Date" | "Boolean"

Comentários

[ Conjunto de API: WordApi 1.3 ]

value

Especifica o valor da propriedade personalizada. Observe que, embora Word na Web e no formato de arquivo docx permitam que essas propriedades sejam arbitrariamente longas, a versão da área de trabalho do Word truncará os valores de cadeia de caracteres para chars de 255 16 bits (possivelmente criando unicódigo inválido dividindo um par de substitutos).

value: any;

Valor da propriedade

any

Comentários

[ Conjunto de API: WordApi 1.3 ]

Detalhes do método

delete()

Exclui a propriedade personalizada.

delete(): void;

Retornos

void

Comentários

[ Conjunto de API: WordApi 1.3 ]

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.CustomPropertyLoadOptions): Word.CustomProperty;

Parâmetros

options

Word.Interfaces.CustomPropertyLoadOptions

Fornece opções para quais propriedades do objeto carregar.

Retornos

Word.CustomProperty

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

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

Word.CustomProperty

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

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

Word.CustomProperty

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

Parâmetros

properties

Word.Interfaces.CustomPropertyUpdateData

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: Word.CustomProperty): void;

Parâmetros

properties

Word.CustomProperty

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.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o Word original. O objeto CustomProperty é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Word.Interfaces.CustomPropertyData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

toJSON(): Word.Interfaces.CustomPropertyData;

Retornos

Word.Interfaces.CustomPropertyData

track()

Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Essa chamada é uma abreviação para context.trackedObjects.add(thisObject). Se você estiver usando esse 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, você precisará adicionar o objeto à coleção de objetos rastreados quando o objeto foi criado pela primeira vez. Se esse objeto fizer parte de uma coleção, você também deverá acompanhar a coleção pai.

track(): Word.CustomProperty;

Retornos

Word.CustomProperty

untrack()

Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Essa 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. Você precisará chamar context.sync() antes que a versão da memória entre em vigor.

untrack(): Word.CustomProperty;

Retornos

Word.CustomProperty