Referência de sintaxe de personalização da barra de comandos

A personalização da barra de comandos ajuda a personalizar uma lista para atender a requisitos específicos. A funcionalidade baseada em JSON permite alterações básicas à barra de comandos, incluindo modificação do ícone e/ou texto, ocultar opções existentes ou reposicionar comandos.

commandBarProps

Propriedades para personalização da barra de comandos. Válido em todos os tipos de layouts.

comandos

É utilizada uma matriz de objetos JSON para especificar os comandos para personalização.

chave

Propriedade obrigatória para identificar exclusivamente um comando na barra de comandos. As chaves válidas incluem:

'new'
'newFolder'
'newWordDocument'
'newExcelWorkbook'
'newPowerPointPresentation'
'newOneNoteNotebook'
'newFormsForExcel'
'newVisioDrawing'
'upload'
'uploadFile'
'uploadFolder'
'open'
'share'
'copyLink'
'download'
'rename'
'copyTo'
'moveTo'
'delete'
'edit'
'comment'
'editNewMenu'
'powerBI'
'powerBIVisualizeList'
'automate'
'automateCreateRule'
'automateManageRules'
'powerAutomate'
'powerAutomateCreateFlow'
'powerAutomateSeeFlows'
'powerAutomateConfigureFlows'
'aiBuilderCreate'
'aiBuilderGoto'
'aiBuilder'
'alertMe'
'newLink'
'integrate'
'manageAlert'
'powerApps'
'powerAppsCreateApp'
'powerAppsSeeAllApps'
'powerAppsCustomizeForms'
'viewDocumentUnderstandingModels'
'versionHistory'
'openInImmersiveReader'
'classifyAndExtract'
'checkOut'
'checkIn'
'undoCheckOut'
'properties'
'pinItem'
'exportExcel'
'exportCSV'
'export'
'editInGridView'
'exitGridView'
'sync'
'uploadTemplate'
'addTemplate'
'openInOfficeOnline'
'openInOfficeClient'
'addShortcut'
'pinToQuickAccess'
'unpinFromQuickAccess'
'manageForms'
'favoriteCommand'
'createCopilot'

⚠️ Atualizações recentes para commandBarCustomization Chaves

Algumas chaves no comandoBarCustomization schema foram atualizadas. Para garantir que o seu formatter personalizado funciona corretamente, atualize o JSON existente para refletir estas novas chaves.

Chave Original	Nova Chave
new	newComposite (Biblioteca de Documentos)
upload	UploadCommand
sync	syncCommand
addShortcut	addShortcutToOneDriveCommand
pinToQuickAccess	PinToQuickAccessCommand
pinItem	pinItemCommand
properties	propertiesCommand
versionHistory	versionHistoryCommand (atualmente não está a funcionar)

Além disso, estão agora disponíveis as seguintes novas chaves de comando:

• stasherContextMenuCommand (Adicionar atalho)
• stasherCommand.myFiles (Adicionar atalho -> os meus Ficheiros)
• stasherCommand.otherLocations (Adicionar atalho --> Outras localizações)
• PublishCommand
• complianceDetails (clique com o botão direito do rato no menu de contexto --> Mais –> Detalhes de conformidade)
• more (clique com o botão direito do rato no menu de contexto --> Mais)
• previewFileCommand (clique com o botão direito do rato no menu de contexto --> Pré-visualização)

Tenha em atenção que o esquema JSON em https://developer.microsoft.com/json-schemas/sp/v2/command-bar-formatting.schema.json ainda não foi atualizado para refletir estas novas chaves de comando.

Chaves de referência para comandos indicados pelas extensões do Conjunto de Comandos SPFx ListView

As referências principais acima abrangem os comandos prontos a utilizar, mas também é comum ter comandos personalizados trazidos através de extensões de Conjunto de Comandos listView do Estrutura do SharePoint (SPFx). Estes comandos também têm uma chave estática que utiliza a seguinte convenção de nomenclatura: SpfxCustomActionNavigationCommand_ + ID da extensão do conjunto de comandos + nome do comando. Os dois últimos podem ser obtidos a partir do ficheiro json de manifesto do conjunto de comandos. No exemplo abaixo, a chave para o comando personalizado seria SpfxCustomActionNavigationCommand_2c5694dc-fdd0-444c-bb1e-8b0741af5a11COMMAND_2:

ocultar

Uma propriedade opcional que especifica a condição para ocultar um comando específico. O valor desta propriedade pode ser um booleano, cadeia de caracteres ou um objeto Expression. false é o comportamento padrão (o que significa que o comando é visível). true significa que o comando ficará oculto.

texto

Uma propriedade opcional que especifica o texto a ser exibido como o nome do comando. O valor dessa propriedade pode ser uma cadeia de caracteres ou um objeto Expression. Se o valor não for fornecido, será apresentado o nome predefinido do comando.

title

Uma propriedade opcional que especifica o texto da dica de ferramenta a ser exibido no comando. O valor dessa propriedade pode ser uma cadeia de caracteres ou um objeto Expression. Se o valor não for fornecido, será apresentada a descrição predefinida do comando.

iconName

Uma propriedade opcional que especifica o ícone Interface do usuário do Fluent a ser exibido no comando. O valor dessa propriedade pode ser uma cadeia de caracteres ou um objeto Expression. Se o valor não for fornecido, será apresentado o ícone predefinido do comando.

primário

Uma propriedade opcional que especifica a condição para aplicar o estilo do botão principal a um comando. O valor desta propriedade pode ser um booleano, cadeia de caracteres ou um objeto Expression. false é o comportamento padrão (o que significa que o estilo padrão será aplicado). true significa que o estilo do botão principal será aplicado ao comando somente se o comando for colocado na posição 0 na barra de comandos.

O exemplo a seguir mostra um exemplo de barra de comando formatando JSON para fazer o seguinte:

• Oculte o comando "Novo".
• Atualize o texto e o ícone do comando 'Editar no modo de exibição de grade' e adicione o estilo do botão principal a ele.
• Remova o ícone do comando 'Compartilhar' e atualize o texto da dica de ferramenta dele.

{
  "commandBarProps" : {
    "commands": [
      {
        "key": "new",
        "hide": true
      },
      {
        "key": "editInGridView",
        "text": "Quick edit",
        "iconName": "EditTable",
        "primary": true
      },
      {
        "key": "share",
        "iconName": "",
        "title": "Share this List"
      }
    ]
  }
}

position

Uma propriedade opcional que especifica a posição onde o comando será colocado na barra de comandos. O valor desta propriedade pode ser um número, uma cadeia ou um objeto Expressão. Se o valor não for fornecido, o comando será colocado em sua posição padrão. Essa propriedade segue a indexação baseada em zero.

sectionType

Uma propriedade opcional que especifica a seção onde o comando personalizado será colocado na barra de comandos. As seguintes cadeias de caracteres são valores válidos para esta propriedade:

• Primário
• Transbordar

O exemplo a seguir mostra um exemplo de barra de comando formatando JSON para fazer o seguinte:

• Coloca o comando 'Novo' na terceira posição na seção principal da barra de comandos.
• Coloca o comando "Partilhar" na segunda posição no menu de capacidade excedida da Barra de comandos.
• Coloca o comando "Alertar-me" na quarta posição na secção primária da Barra de comandos.

{
  "commandBarProps" : {
    "commands": [
      {
        "key": "new",
        "position": 2
      },
       {
        "key": "share",
        "position": 1,
        "sectionType": "Overflow"
      },
      {
        "key": "alertMe",
        "position": 3,
        "sectionType": "Primary"
      }
    ]
  }
}

selectionModes

Uma propriedade opcional que especifica os modos de seleção nos quais a customização do comando será aplicada. Se o valor não for fornecido, a personalização será aplicada em todos os modos de seleção nos quais o comando está disponível. O valor desta propriedade pode ser uma matriz de cadeias onde são permitidas as seguintes cadeias:

• Nenhuma seleção
• SingleSelection
• MultiSelection

O exemplo a seguir mostra um exemplo de barra de comando formatando JSON para fazer o seguinte:

• Atualize o texto do comando 'Compartilhar' se o item selecionado tiver o valor de coluna 'NumberField' 3
• Atualize o texto do comando 'Excluir' somente se vários itens estiverem selecionados.

{
  "commandBarProps": {
    "commands": [
      {
        "key": "share",
        "selectionModes": [
          "SingleSelection"
        ],
        "text": "=if([$NumberField] == 3, 'Share item 3', 'Share')"
      },
      {
        "key": "delete",
         "selectionModes": [
          "MultiSelection"
        ],
        "text": "Delete multiple items"
      }
    ]
  }
}