Compartilhar via


Excel.LinkedEntityDataDomainCreateOptions interface

Representa as opções utilizadas para criar o objeto que LinkedEntityDataDomain está a ser adicionado ao LinkedEntityDataDomainCollection.

Comentários

[ Conjunto de API: ExcelApi 1.19 ]

Propriedades

dataProvider

Especifica o nome do fornecedor de dados para o domínio de dados da entidade ligada.

id

Especifica o ID do domínio de dados da entidade ligada. Este ID tem de ser exclusivo em todos os domínios de dados de entidades ligadas definidos por este Suplemento do Office.

loadFunctionId

Especifica o ID da função personalizada que será chamada a pedido para resolve ou atualizar os LinkedEntityCellValue objetos deste domínio de dados de entidade ligada. Para obter mais informações, veja Autogenerate JSON metadata for custom functions: ID (Gerar automaticamente metadados JSON para funções personalizadas: ID).

name

Especifica o nome do domínio de dados da entidade ligada. Este nome tem de ser exclusivo em todos os domínios de dados de entidades ligadas definidos por este Suplemento do Office.

periodicRefreshInterval

Especifica a frequência, em segundos, na qual LinkedEntityCellValue os objetos deste domínio de dados de entidade ligada são atualizados automaticamente. O valor mínimo válido é 300. Esta propriedade é necessária se a supportedRefreshModes matriz contiver o valor "Periódico". Esta propriedade só se aplica se o refreshMode domínio de dados da entidade ligada estiver definido como "Periódico".

supportedRefreshModes

Especifica todos os modos de atualização suportados pelo domínio de dados da entidade ligada. O valor predefinido é ["Manual"], que é sempre suportado mesmo que não seja especificado. O modo de atualização guardado no livro é carregado como o modo de atualização predefinido do domínio de dados da entidade ligada no livro seguinte aberto. Se o modo de atualização não tiver sido guardado no livro, o primeiro valor na matriz é definido como o modo de atualização predefinido do domínio de dados da entidade ligada. Se a matriz tiver o valor "Periodic", a periodicRefreshInterval propriedade também tem de ser definida para o domínio de dados da entidade ligada.

Detalhes da propriedade

dataProvider

Especifica o nome do fornecedor de dados para o domínio de dados da entidade ligada.

dataProvider: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.19 ]

id

Especifica o ID do domínio de dados da entidade ligada. Este ID tem de ser exclusivo em todos os domínios de dados de entidades ligadas definidos por este Suplemento do Office.

id: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.19 ]

loadFunctionId

Especifica o ID da função personalizada que será chamada a pedido para resolve ou atualizar os LinkedEntityCellValue objetos deste domínio de dados de entidade ligada. Para obter mais informações, veja Autogenerate JSON metadata for custom functions: ID (Gerar automaticamente metadados JSON para funções personalizadas: ID).

loadFunctionId: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.19 ]

name

Especifica o nome do domínio de dados da entidade ligada. Este nome tem de ser exclusivo em todos os domínios de dados de entidades ligadas definidos por este Suplemento do Office.

name: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.19 ]

periodicRefreshInterval

Especifica a frequência, em segundos, na qual LinkedEntityCellValue os objetos deste domínio de dados de entidade ligada são atualizados automaticamente. O valor mínimo válido é 300. Esta propriedade é necessária se a supportedRefreshModes matriz contiver o valor "Periódico". Esta propriedade só se aplica se o refreshMode domínio de dados da entidade ligada estiver definido como "Periódico".

periodicRefreshInterval?: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.19 ]

supportedRefreshModes

Especifica todos os modos de atualização suportados pelo domínio de dados da entidade ligada. O valor predefinido é ["Manual"], que é sempre suportado mesmo que não seja especificado. O modo de atualização guardado no livro é carregado como o modo de atualização predefinido do domínio de dados da entidade ligada no livro seguinte aberto. Se o modo de atualização não tiver sido guardado no livro, o primeiro valor na matriz é definido como o modo de atualização predefinido do domínio de dados da entidade ligada. Se a matriz tiver o valor "Periodic", a periodicRefreshInterval propriedade também tem de ser definida para o domínio de dados da entidade ligada.

supportedRefreshModes?: Excel.LinkedEntityDataDomainRefreshMode[];

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.19 ]