Espaço pré-alocado para espaços reservados de extensão da Estrutura do SharePoint

Os personalizadores de aplicativo podem ser usados para adicionar estruturas e conteúdo nas páginas modernas. Isso pode ser obtido usando espaços reservados específicos na página, para os quais a extensibilidade personalizada será carregada. Como as extensões serão carregadas muito tarde no ciclo de vida de carregamento da página, pode haver movimentação de página adicional quando as extensões forem adicionadas.

Observação

Esse recurso só tem suporte no SharePoint Online.

Para reduzir a movimentação da página, você pode pré-alocar a área de extensão já no lado do servidor quando a estrutura da página for criada. Essa configuração pode ser aplicada usando uma nova HostProperties propriedade na UserCustomAction coleção para indicar no lado do servidor quais personalizadores de aplicativo são carregados na página.

Há duas propriedades específicas diferentes, que podem ser usadas com a HostProperties configuração:

• preAllocatedApplicationCustomizerTopHeight: altura pré-alocada para o espaço reservado superior
• preAllocatedApplicationCustomizerBottomHeight: altura pré-alocada para o espaço reservado inferior

A altura está sendo definida em pixels.

Definindo a alocação de HostProperties na solução Estrutura do SharePoint

Você pode definir a pré-alocação do lado do servidor diretamente no código da solução Estrutura do SharePoint, que garante que a pré-alocação seja aplicada quando a solução está sendo usada. A pré-alocação pode ser definida no elements.xml ou nos arquivos ClientSideInstance.xml , dependendo do design da solução.

O valor das propriedades do host precisa ser codificado corretamente nos arquivos xml para garantir que a embalagem da solução seja bem-sucedida.

Definindo a pré-alocação na implantação no escopo do site

Se sua extensão for projetada para ser instalada em um escopo de site, você poderá configurar a pré-alocação usando o arquivo ./sharepoint/assets/elements.xml . A configuração incluída neste arquivo é, por padrão, aplicada ao site, quando Estrutura do SharePoint solução é instalada em um escopo do site.

O fragmento xml a seguir foi atualizado com a entrada adicional HostProperties e definiu a altura padrão como 50 pixels.

<?xml version="1.0" encoding="utf-8"?>
<Elements xmlns="http://schemas.microsoft.com/sharepoint/">
  <CustomAction
      Title="HeaderDemo"
      Location="ClientSideExtension.ApplicationCustomizer"
      ClientSideComponentId="03dd08c7-2575-4336-899e-68cfce663c4d"
      ClientSideComponentProperties="{&quot;testMessage&quot;:&quot;Test message&quot;}"
      HostProperties="{&quot;preAllocatedApplicationCustomizerTopHeight&quot;:&quot;50&quot;,&quot;preAllocatedApplicationCustomizerBottomHeight&quot;:&quot;50&quot;}">
  </CustomAction>
</Elements>

Definir a pré-alocação usando a opção de implantação em todo o locatário

As extensões direcionadas a serem ativadas usando as opções de implantação em todo o locatário podem ser configuradas para usar o espaço pré-alocado adicionando HostProperties propriedade para o ClientSideComponentInstance elemento no arquivo ./sharepoint/assets/ClientSideInstance.xml .

<?xml version="1.0" encoding="utf-8"?>
<Elements xmlns="http://schemas.microsoft.com/sharepoint/">
  <ClientSideComponentInstance
      Title="HeaderDemo"
      Location="ClientSideExtension.ApplicationCustomizer"
      ComponentId="03dd08c7-2575-4336-899e-68cfce663c4d"
      Properties="{&quot;testMessage&quot;:&quot;Test message&quot;}"
      HostProperties="{&quot;preAllocatedApplicationCustomizerTopHeight&quot;:&quot;50&quot;,&quot;preAllocatedApplicationCustomizerBottomHeight&quot;:&quot;50&quot;}">
  </ClientSideComponentInstance>
</Elements>

HostProperties A entrada dessa configuração será adicionada à entrada da lista extensões amplas de locatário na coleção de sites do Catálogo de Aplicativos, que tem uma coluna Propriedades do Host para cada item.

Considerações

Há poucas considerações a serem conscientes, dependendo da implementação:

• Quando a altura determinada for demais, o div terá espaço extra na posição designada. Se a altura for menor que os personalizadores de aplicativo, os personalizadores de aplicativo serão compactados no espaço reservado.
• Se você tiver definido uma pré-alocação, mas o personalizador de aplicativo não criar espaço reservado no código ou não estiver associado na página, o espaço alocado do lado do servidor permanecerá na página.

Observação

HostProperties também pode ser definido para personalizadores de aplicativo existentes modificando o objeto CustomAction no nível do site ou usando a coluna Propriedades do Host na lista Extensões Amplas de Locatários no site do catálogo de aplicativos. Como essa é uma configuração do lado do servidor, ela também pode ser aplicada a extensões que foram criadas usando versões Estrutura do SharePoint mais antigas.